<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_v12.diff)<br/>
+
<br/>
Copyright © 2017 AT&T Intellectual Property. All rights reserved.<br/>
<br/>
<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--esr-system-info-list-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list</a></td>
+ <td><p>returns esr-system-info-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}</a></td>
+ <td><p>returns esr-system-info</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}</a></td>
+ <td><p>create or update an existing esr-system-info</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}</a></td>
+ <td><p>update an existing esr-system-info</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}</a></td>
+ <td><p>delete an existing esr-system-info</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship</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--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
</td>
</tr>
<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--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities</a></td>
+ <td><p>returns hpa-capabilities</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>returns hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>create or update an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>update an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>delete an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>returns hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>create or update an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>update an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>delete an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/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--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/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-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-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--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
</td>
</tr>
<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--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</a></td>
+ <td><p>returns hpa-capabilities</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>returns hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>create or update an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>update an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td>
+ <td><p>delete an existing hpa-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>returns hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>create or update an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>update an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</a></td>
+ <td><p>delete an existing hpa-feature-attributes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/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--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/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--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-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--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
</td>
</tr>
<tr>
<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">
resource-instance-id
</td>
<td>
- <p>Unique id of resource instance.</p>
</td>
- <td>path</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>
<tr>
model-invariant-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
model-version-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<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>
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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/connector">/connector</a>
+ <a class="json-schema-ref" href="#/definitions/connectors">/connectors</a>
</div>
</div>
</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 id="operation--business-connectors-connector--resource-instance-id--get" class="swagger--panel-operation-get 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>
+ <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>create or update an existing connector</p>
+ <p>returns 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/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/connector">/connector</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 id="operation--business-connectors-connector--resource-instance-id--put" class="swagger--panel-operation-put 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>
+ <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>update an existing connector</p>
+ <p>create or update an existing connector</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>connector object that needs to be created or updated.</p>
+ <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>
+ <a class="json-schema-ref" href="#/definitions/connector">/connector</a>
</div>
</div></div>
</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 id="operation--business-connectors-connector--resource-instance-id--patch" class="swagger--panel-operation-patch 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>
+ <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>delete an existing connector</p>
+ <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 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="#/definitions/connector">/connector</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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>
</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">
+ <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">returns metadata</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata</strong></h3>
+ <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>returns metadata</p>
+ <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>
<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
+ resource-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>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 metadatum</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ <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 metadatum</p>
+ <p>returns metadata</p>
</section>
<section class="sw-request-params">
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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ <a class="json-schema-ref" href="#/definitions/metadata">/metadata</a>
</div>
</div>
</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 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">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>
+ <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>create or update an existing metadatum</p>
+ <p>returns 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/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>update an existing metadatum</p>
+ <p>create or update an existing metadatum</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>metadatum object that needs to be created or updated.</p>
+ <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>
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
</div>
</div></div>
</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 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">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>
+ <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>delete an existing metadatum</p>
+ <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 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="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<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>
</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 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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</div>
</div>
- <span id="path--business-customers-"></span>
- <div id="operation--business-customers-get" class="swagger--panel-operation-get panel">
+ <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">returns customers</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers</strong></h3>
+ <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>returns customers</p>
+ <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-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 customer</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}</strong></h3>
+ <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 customer</p>
+ <p>returns customers</p>
</section>
<section class="sw-request-params">
global-customer-id
</td>
<td>
- <p>Global customer id used across ECOMP to uniquely identify customer.</p>
</td>
- <td>path</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>
<tr>
subscriber-name
</td>
<td>
- <p>Subscriber name, an alternate way to retrieve a customer.</p>
</td>
<td>query</td>
<td>
subscriber-type
</td>
<td>
- <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/customer">/customer</a>
+ <a class="json-schema-ref" href="#/definitions/customers">/customers</a>
</div>
</div>
</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 id="operation--business-customers-customer--global-customer-id--get" class="swagger--panel-operation-get 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>
+ <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>create or update an existing customer</p>
+ <p>returns 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/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/customer">/customer</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 id="operation--business-customers-customer--global-customer-id--put" class="swagger--panel-operation-put 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>
+ <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>update an existing customer</p>
+ <p>create or update an existing customer</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>customer object that needs to be created or updated.</p>
+ <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>
+ <a class="json-schema-ref" href="#/definitions/customer">/customer</a>
</div>
</div></div>
</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 id="operation--business-customers-customer--global-customer-id--patch" class="swagger--panel-operation-patch 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>
+ <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>delete an existing customer</p>
+ <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 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="#/definitions/customer">/customer</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<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>
</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 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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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">
+ <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">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>
+ <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>returns service-subscriptions</p>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</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>
- subscriber-name
+ global-customer-id
</td>
<td>
- <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-type
+ service-type
</td>
<td>
- <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service-subscriptions">/service-subscriptions</a>
+ <a class="json-schema-ref" href="#/definitions/service-subscriptions">/service-subscriptions</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service-subscription">/service-subscription</a>
+ <a class="json-schema-ref" href="#/definitions/service-subscription">/service-subscription</a>
</div>
</div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)</p>
+ <p><p>service-subscription object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>service-subscription object that needs to be created or updated.</p>
+ <p><p>service-subscription object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/service-subscription">/service-subscription</a>
</div>
</div></div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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">
service-instance-id
</td>
<td>
- <p>Uniquely identifies this instance of a service</p>
</td>
- <td>path</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>
<tr>
<td>
- subscriber-name
+ service-instance-name
</td>
<td>
- <p>Subscriber name, an alternate way to retrieve a customer.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- subscriber-type
+ environment-context
</td>
<td>
- <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- service-instance-name
+ workload-context
</td>
<td>
- <p>This field will store a name assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- environment-context
+ model-invariant-id
</td>
<td>
- <p>This field will store the environment context assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- workload-context
+ model-version-id
</td>
<td>
- <p>This field will store the workload context assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-invariant-id
+ widget-model-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-version-id
+ widget-model-version
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- widget-model-id
+ service-instance-location-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- widget-model-version
+ orchestration-status
</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>
<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="#/definitions/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>
- service-instance-location-id
+ global-customer-id
</td>
<td>
- <p>An identifier that customers assign to the location where this service is being used.</p>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- orchestration-status
+ service-type
</td>
<td>
- <p>Orchestration status of this service.</p>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service-instance">/service-instance</a>
+ <a class="json-schema-ref" href="#/definitions/service-instance">/service-instance</a>
</div>
</div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)</p>
+ <p><p>service-instance object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>service-instance object that needs to be created or updated.</p>
+ <p><p>service-instance object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/service-instance">/service-instance</a>
</div>
</div></div>
</div>
</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
+ id
</td>
<td>
- <p>This field will store a name assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- environment-context
+ model-invariant-id
</td>
<td>
- <p>This field will store the environment context assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- workload-context
+ model-version-id
</td>
<td>
- <p>This field will store the workload context assigned to the service-instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-invariant-id
+ type
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-version-id
+ role
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<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="#/definitions/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>
- widget-model-id
+ global-customer-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ service-type
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-location-id
+ service-instance-id
</td>
<td>
- <p>An identifier that customers assign to the location where this service is being used.</p>
+ <p>Uniquely identifies this instance of a service</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- orchestration-status
+ id
</td>
<td>
- <p>Orchestration status of this service.</p>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/allotted-resource">/allotted-resource</a>
</div>
</div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)</p>
+ <p><p>allotted-resource object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>allotted-resource object that needs to be created or updated.</p>
+ <p><p>allotted-resource object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/allotted-resource">/allotted-resource</a>
</div>
</div></div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ id
</td>
<td>
- <p>role in the network that this resource will be providing.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/tunnel-xconnects">/tunnel-xconnects</a>
+ <a class="json-schema-ref" href="#/definitions/tunnel-xconnects">/tunnel-xconnects</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/tunnel-xconnect">/tunnel-xconnect</a>
+ <a class="json-schema-ref" href="#/definitions/tunnel-xconnect">/tunnel-xconnect</a>
</div>
</div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)</p>
+ <p><p>tunnel-xconnect object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>tunnel-xconnect object that needs to be created or updated.</p>
+ <p><p>tunnel-xconnect object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/tunnel-xconnect">/tunnel-xconnect</a>
</div>
</div></div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ metaname
</td>
<td>
- <p>Orchestration status of this service.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ <a class="json-schema-ref" href="#/definitions/metadata">/metadata</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
</div>
</div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)</p>
+ <p><p>metadatum object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>metadatum object that needs to be created or updated.</p>
+ <p><p>metadatum object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
</div>
</div></div>
</div>
</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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns lines-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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/lines-of-business">/lines-of-business</a>
+ <a class="json-schema-ref" href="#/definitions/lines-of-business">/lines-of-business</a>
</div>
</div>
</div>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/line-of-business">/line-of-business</a>
+ <a class="json-schema-ref" href="#/definitions/line-of-business">/line-of-business</a>
</div>
</div>
</div>
</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/v12/BusinessLinesOfBusinessLineOfBusiness.json)</p>
+ <p><p>line-of-business object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>line-of-business object that needs to be created or updated.</p>
+ <p><p>line-of-business object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/line-of-business">/line-of-business</a>
</div>
</div></div>
</div>
</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/v12/BusinessLinesOfBusinessLineOfBusiness.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns owning-entities</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/owning-entities">/owning-entities</a>
+ <a class="json-schema-ref" href="#/definitions/owning-entities">/owning-entities</a>
</div>
</div>
</div>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/owning-entity">/owning-entity</a>
+ <a class="json-schema-ref" href="#/definitions/owning-entity">/owning-entity</a>
</div>
</div>
</div>
</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/v12/BusinessOwningEntitiesOwningEntity.json)</p>
+ <p><p>owning-entity object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>owning-entity object that needs to be created or updated.</p>
+ <p><p>owning-entity object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/owning-entity">/owning-entity</a>
</div>
</div></div>
</div>
</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/v12/BusinessOwningEntitiesOwningEntity.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns platforms</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/platforms">/platforms</a>
+ <a class="json-schema-ref" href="#/definitions/platforms">/platforms</a>
</div>
</div>
</div>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/platform">/platform</a>
+ <a class="json-schema-ref" href="#/definitions/platform">/platform</a>
</div>
</div>
</div>
</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/v12/BusinessPlatformsPlatform.json)</p>
+ <p><p>platform object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>platform object that needs to be created or updated.</p>
+ <p><p>platform object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/platform">/platform</a>
</div>
</div></div>
</div>
</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/v12/BusinessPlatformsPlatform.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns projects</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/projects">/projects</a>
+ <a class="json-schema-ref" href="#/definitions/projects">/projects</a>
</div>
</div>
</div>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/project">/project</a>
+ <a class="json-schema-ref" href="#/definitions/project">/project</a>
</div>
</div>
</div>
</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/v12/BusinessProjectsProject.json)</p>
+ <p><p>project object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>project object that needs to be created or updated.</p>
+ <p><p>project object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/project">/project</a>
</div>
</div></div>
</div>
</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/v12/BusinessProjectsProject.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns cloud-regions</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </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>
+ <tr>
+ <td>
+ cloud-type
+ </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>
+ <tr>
+ <td>
+ owner-defined-type
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/cloud-regions">/cloud-regions</a>
+ <a class="json-schema-ref" href="#/definitions/cloud-regions">/cloud-regions</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/cloud-region">/cloud-region</a>
+ <a class="json-schema-ref" href="#/definitions/cloud-region">/cloud-region</a>
</div>
</div>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegion.json)</p>
+ <p><p>cloud-region object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>cloud-region object that needs to be created or updated.</p>
+ <p><p>cloud-region object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/cloud-region">/cloud-region</a>
</div>
</div></div>
</div>
</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
+ availability-zone-name
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/availability-zones">/availability-zones</a>
+ <a class="json-schema-ref" href="#/definitions/availability-zones">/availability-zones</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/availability-zone">/availability-zone</a>
+ <a class="json-schema-ref" href="#/definitions/availability-zone">/availability-zone</a>
</div>
</div>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)</p>
+ <p><p>availability-zone object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>availability-zone object that needs to be created or updated.</p>
+ <p><p>availability-zone object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/availability-zone">/availability-zone</a>
</div>
</div></div>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- cloud-type
+ switch-name
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- owner-defined-type
+ vcenter-url
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/dvs-switches">/dvs-switches</a>
+ <a class="json-schema-ref" href="#/definitions/dvs-switches">/dvs-switches</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/dvs-switch">/dvs-switch</a>
+ <a class="json-schema-ref" href="#/definitions/dvs-switch">/dvs-switch</a>
</div>
</div>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)</p>
+ <p><p>dvs-switch object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>dvs-switch object that needs to be created or updated.</p>
+ <p><p>dvs-switch object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/dvs-switch">/dvs-switch</a>
</div>
</div></div>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-get" class="swagger--panel-operation-get panel">
<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>
+ <div class="operation-summary">returns esr-system-info-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns flavors</p>
+ <p>returns esr-system-info-list</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- cloud-type
+ esr-system-info-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- owner-defined-type
+ system-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>
+ <tr>
+ <td>
+ system-type
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/flavors">/flavors</a>
+ <a class="json-schema-ref" href="#/definitions/esr-system-info-list">/esr-system-info-list</a>
</div>
</div>
</div>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--get" class="swagger--panel-operation-get panel">
<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>
+ <div class="operation-summary">returns esr-system-info</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns flavor</p>
+ <p>returns esr-system-info</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/flavor">/flavor</a>
+ <a class="json-schema-ref" href="#/definitions/esr-system-info">/esr-system-info</a>
</div>
</div>
</div>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--put" class="swagger--panel-operation-put panel">
<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>
+ <div class="operation-summary">create or update an existing esr-system-info</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-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>
+ <p>create or update an existing esr-system-info</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)</p>
+ <p><p>esr-system-info 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="#/definitions/flavor">/flavor</a>
+ <a class="json-schema-ref" href="#/definitions/esr-system-info">/esr-system-info</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--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>
+ <div class="operation-summary">update an existing esr-system-info</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-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>
+ <p>update an existing esr-system-info</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>flavor object that needs to be created or updated.</p>
+ <p><p>esr-system-info object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/esr-system-info">/esr-system-info</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete" class="swagger--panel-operation-delete panel">
<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>
+ <div class="operation-summary">delete an existing esr-system-info</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-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>
+ <p>delete an existing esr-system-info</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
<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>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
<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>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
</tr>
<tr>
<td>
- flavor-id
+ esr-system-info-id
</td>
<td>
- <p>Flavor id, expected to be unique across cloud-region.</p>
+ <p>Unique ID of esr system info.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 group-assignments</p>
+ <p>returns flavors</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- cloud-type
+ flavor-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- owner-defined-type
+ flavor-name
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/group-assignments">/group-assignments</a>
+ <a class="json-schema-ref" href="#/definitions/flavors">/flavors</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 group-assignment</p>
+ <p>returns flavor</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- group-id
+ flavor-id
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/group-assignment">/group-assignment</a>
+ <a class="json-schema-ref" href="#/definitions/flavor">/flavor</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 group-assignment</p>
+ <p>create or update an existing flavor</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)</p>
+ <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="#/definitions/group-assignment">/group-assignment</a>
+ <a class="json-schema-ref" href="#/definitions/flavor">/flavor</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- group-id
+ flavor-id
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 group-assignment</p>
+ <p>update an existing flavor</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>group-assignment object that needs to be created or updated.</p>
+ <p><p>flavor object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/flavor">/flavor</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- group-id
+ flavor-id
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 group-assignment</p>
+ <p>delete an existing flavor</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- group-id
+ flavor-id
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-get" class="swagger--panel-operation-get 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>
+ <div class="operation-summary">returns hpa-capabilities</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}/hpa-capabilities</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>
+ <p>returns hpa-capabilities</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tr>
<td>
- group-id
+ flavor-id
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </div>
- </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
+ hpa-capability-id
</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>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>
<tr>
<td>
- cloud-region-id
+ hpa-feature
</td>
<td>
- <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>path</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>
<tr>
<td>
- group-id
+ architecture
</td>
<td>
- <p>Group id, expected to be unique across cloud-region.</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/hpa-capabilities">/hpa-capabilities</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--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>
+ <div class="operation-summary">returns hpa-capability</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns images</p>
+ <p>returns hpa-capability</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- cloud-type
+ flavor-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ hpa-capability-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/images">/images</a>
+ <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a>
</div>
</div>
</div>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put" class="swagger--panel-operation-put 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>
+ <div class="operation-summary">create or update an existing hpa-capability</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns image</p>
+ <p>create or update an existing hpa-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>hpa-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="#/definitions/hpa-capability">/hpa-capability</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<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
+ hpa-capability-id
</td>
<td>
- <p>The application that the image instantiates.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
- <td>query</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>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch" class="swagger--panel-operation-patch 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>
+ <div class="operation-summary">update an existing hpa-capability</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}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <p>update an existing hpa-capability</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)</p>
+ <p><p>hpa-capability object that needs to be 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="#/definitions/image">/image</a>
+ <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <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>
+ hpa-capability-id
+ </td>
+ <td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete" class="swagger--panel-operation-delete 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>
+ <div class="operation-summary">delete an existing hpa-capability</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}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <p>delete an existing hpa-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>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">
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <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>
+ hpa-capability-id
+ </td>
+ <td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</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>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--get" class="swagger--panel-operation-get 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>
+ <div class="operation-summary">returns hpa-feature-attributes</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</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>
+ <p>returns hpa-feature-attributes</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ hpa-capability-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
+ </td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--put" class="swagger--panel-operation-put 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>
+ <div class="operation-summary">create or update an existing hpa-feature-attributes</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns metadata</p>
+ <p>create or update an existing hpa-feature-attributes</p>
</section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>hpa-feature-attributes 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="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<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>
+ hpa-capability-id
</td>
<td>
- </td>
- </tr>
- <tr>
- <td>
- application-vendor
- </td>
- <td>
- <p>The vendor of the application.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-version
+ hpa-attribute-key
</td>
<td>
- <p>The version of the application.</p>
+ <p>name of the specific HPA attribute</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--patch" class="swagger--panel-operation-patch 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>
+ <div class="operation-summary">update an existing hpa-feature-attributes</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns metadatum</p>
+ <p>update an existing hpa-feature-attributes</p>
</section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>hpa-feature-attributes object that needs to be 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="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ hpa-capability-id
</td>
<td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<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
+ hpa-attribute-key
</td>
<td>
- <p>The version of the application.</p>
+ <p>name of the specific HPA attribute</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--delete" class="swagger--panel-operation-delete 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>
+ <div class="operation-summary">delete an existing hpa-feature-attributes</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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</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>
+ <p>delete an existing hpa-feature-attributes</p>
</section>
<section class="sw-request-body">
<p><span class="label 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/v12/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">
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ hpa-capability-id
</td>
<td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-put" class="swagger--panel-operation-put 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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship</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>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>metadatum object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ hpa-capability-id
</td>
<td>
+ <p>UUID to uniquely identify a HPA capability</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/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 metadatum</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ hpa-capability-id
</td>
<td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ hpa-attribute-key
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>name of the specific HPA attribute</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <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>
+ hpa-capability-id
+ </td>
+ <td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
</tr>
<tr>
<td>
- image-id
+ flavor-id
</td>
<td>
- <p>Image id, expected to be unique across cloud region</p>
+ <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>
+ hpa-capability-id
+ </td>
+ <td>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns oam-networks</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
+ flavor-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns oam-network</p>
+ <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>
<tr>
<td>
- network-uuid
+ flavor-id
</td>
<td>
- <p>UUID of the network. Unique across a cloud-region</p>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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-type
+ cloud-owner
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ 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>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ group-type
</td>
<td>
- <p>Name of the network.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ group-name
</td>
<td>
- <p>cvlan-id</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/oam-network">/oam-network</a>
+ <a class="json-schema-ref" href="#/definitions/group-assignments">/group-assignments</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing oam-network</p>
+ <p>returns 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>oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- network-uuid
+ group-id
</td>
<td>
- <p>UUID of the network. Unique across a cloud-region</p>
+ <p>Group id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing oam-network</p>
+ <p>create or update an existing group-assignment</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>oam-network object that needs to be created or updated.</p>
+ <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/oam-network">/oam-network</a>
+ <a class="json-schema-ref" href="#/definitions/group-assignment">/group-assignment</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- network-uuid
+ group-id
</td>
<td>
- <p>UUID of the network. Unique across a cloud-region</p>
+ <p>Group id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing oam-network</p>
+ <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 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="#/definitions/group-assignment">/group-assignment</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- network-uuid
+ group-id
</td>
<td>
- <p>UUID of the network. Unique across a cloud-region</p>
+ <p>Group id, expected to be unique across cloud-region.</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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
+ group-id
</td>
<td>
- <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ <p>Group id, expected to be unique across cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- network-uuid
+ resource-version
</td>
<td>
- <p>UUID of the network. Unique across a cloud-region</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureCloudRegionsCloudRegion.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-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>
+ <div class="operation-summary">returns hpa-capabilities</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns snapshots</p>
+ <p>returns hpa-capabilities</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- cloud-type
+ hpa-capability-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- owner-defined-type
+ hpa-feature
+ </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>
+ <tr>
+ <td>
+ architecture
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/snapshots">/snapshots</a>
+ <a class="json-schema-ref" href="#/definitions/hpa-capabilities">/hpa-capabilities</a>
</div>
</div>
</div>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <div class="operation-summary">returns hpa-capability</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns snapshot</p>
+ <p>returns hpa-capability</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/snapshot">/snapshot</a>
+ <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a>
</div>
</div>
</div>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <div class="operation-summary">create or update an existing hpa-capability</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <p>create or update an existing hpa-capability</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)</p>
+ <p><p>hpa-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="#/definitions/snapshot">/snapshot</a>
+ <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <div class="operation-summary">update an existing hpa-capability</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <p>update an existing hpa-capability</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>snapshot object that needs to be created or updated.</p>
+ <p><p>hpa-capability object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-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>
+ <div class="operation-summary">delete an existing hpa-capability</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <p>delete an existing hpa-capability</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--get" class="swagger--panel-operation-get 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>
+ <div class="operation-summary">returns hpa-feature-attributes</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</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>
+ <p>returns hpa-feature-attributes</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--put" class="swagger--panel-operation-put 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>
+ <div class="operation-summary">create or update an existing hpa-feature-attributes</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</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>
+ <p>create or update an existing hpa-feature-attributes</p>
</section>
<section class="sw-request-body">
<p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
</p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>hpa-feature-attributes 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="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- snapshot-id
+ hpa-capability-id
</td>
<td>
- <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--patch" class="swagger--panel-operation-patch 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>
+ <div class="operation-summary">update an existing hpa-feature-attributes</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns tenants</p>
+ <p>update an existing hpa-feature-attributes</p>
</section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>hpa-feature-attributes object that needs to be 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="#/definitions/hpa-feature-attributes">/hpa-feature-attributes</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- cloud-type
+ hpa-capability-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ hpa-attribute-key
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>name of the specific HPA attribute</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--delete" class="swagger--panel-operation-delete 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>
+ <div class="operation-summary">delete an existing hpa-feature-attributes</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}</strong></h3>
Tags:
<a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns tenant</p>
+ <p>delete an existing hpa-feature-attributes</p>
</section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- tenant-id
+ hpa-capability-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<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
+ hpa-attribute-key
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>name of the specific HPA attribute</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ resource-version
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship</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>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)</p>
+ <p><p>relationship 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="#/definitions/tenant">/tenant</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- tenant-id
+ hpa-capability-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attributes--hpa-attribute-key--relationship-list-relationship-delete" class="swagger--panel-operation-delete 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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship</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>
+ <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>
- <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">
</tr>
<tr>
<td>
- tenant-id
+ hpa-capability-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ hpa-attribute-key
+ </td>
+ <td>
+ <p>name of the specific HPA attribute</p>
</td>
<td>path</td>
<td>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put" class="swagger--panel-operation-put 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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-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 tenant</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- tenant-id
+ hpa-capability-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</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>
</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">
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete 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>
+ <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}/hpa-capabilities/hpa-capability/{hpa-capability-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>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- tenant-id
+ hpa-capability-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID to uniquely identify a HPA capability</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns images</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
</td>
- <td>path</td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/images">/images</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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 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>
+ <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 vservers</p>
+ <p>returns image</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vservers">/vservers</a>
+ <a class="json-schema-ref" href="#/definitions/image">/image</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>returns vserver</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cloud-type
+ cloud-region-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ image-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- tenant-name
+ cloud-owner
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ cloud-region-id
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ image-id
</td>
<td>
- <p>Name of vserver</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ resource-version
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- prov-status
+ cloud-region-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- in-maint
+ image-id
</td>
<td>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- is-closed-loop-disabled
+ metaname
</td>
<td>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vserver">/vserver</a>
+ <a class="json-schema-ref" href="#/definitions/metadata">/metadata</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing vserver</p>
+ <p>returns 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>vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ metaname
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing vserver</p>
+ <p>create or update an existing metadatum</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vserver object that needs to be created or updated.</p>
+ <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/vserver">/vserver</a>
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ metaname
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing vserver</p>
+ <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 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="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ metaname
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>returns l-interfaces</p>
+ <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>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ metaname
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
</td>
<td>path</td>
<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
+ resource-version
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<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>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns l-interface</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- tenant-id
+ image-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<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
+ image-id
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Image id, expected to be unique across cloud region</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- tenant-context
+ cloud-owner
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ cloud-region-id
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ network-uuid
</td>
<td>
- <p>Alternative name of vserver</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ network-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</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
+ cvlan-tag
</td>
<td>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <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="#/definitions/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>
- interface-id
+ cloud-owner
</td>
<td>
- <p>ID of interface</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ cloud-region-id
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ network-uuid
</td>
<td>
- <p>Name of the network</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/oam-network">/oam-network</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>create or update an existing oam-network</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)</p>
+ <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="#/definitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/oam-network">/oam-network</a>
</div>
</div></div>
</div>
</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
+ network-uuid
</td>
<td>
- <p>Name given to the interface</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>update an existing oam-network</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <p><p>oam-network object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/oam-network">/oam-network</a>
</div>
</div></div>
</div>
</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
+ network-uuid
</td>
<td>
- <p>Name given to the interface</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>delete an existing oam-network</p>
</section>
<section class="sw-request-body">
</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
+ network-uuid
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ resource-version
</td>
<td>
- <p>Name given to the interface</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
- <td>
- <span class="json-property-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>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- tenant-id
+ network-uuid
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ network-uuid
</td>
<td>
- <p>IP address</p>
+ <p>UUID of the network. Unique across a cloud-region</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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. </p>
+ </p>
+ </div>
+ <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-type
+ cloud-owner
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ cloud-region-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- tenant-name
+ cloud-owner
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ cloud-region-id
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vserver-name
+ cloud-owner
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ cloud-region-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ snapshot-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- in-maint
+ snapshot-name
</td>
<td>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- is-closed-loop-disabled
+ application
</td>
<td>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ application-vendor
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ application-version
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ prev-snapshot-id
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<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="#/definitions/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>
- vlan-id-inner
+ cloud-owner
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ cloud-region-id
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ snapshot-id
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/snapshot">/snapshot</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>create or update an existing snapshot</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/snapshot">/snapshot</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- tenant-id
+ snapshot-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <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-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ snapshot-id
</td>
<td>
- <p>IP address</p>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- tenant-id
+ snapshot-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ resource-version
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ snapshot-id
</td>
<td>
- <p>IP address</p>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- tenant-id
+ snapshot-id
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <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-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
<tr>
<td>
- resource-version
+ tenant-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>
+ <tr>
+ <td>
+ tenant-context
</td>
<td>
- <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/tenants">/tenants</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/tenant">/tenant</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- vserver-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ cloud-region-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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>
<tr>
<td>
- vserver-id
+ resource-version
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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. </p>
+ </p>
+ </div>
+ <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>Name given to the interface</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ cloud-region-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cloud-type
+ tenant-id
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- owner-defined-type
+ cloud-owner
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ cloud-region-id
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ tenant-id
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vserver-name
+ cloud-owner
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ cloud-region-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ tenant-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ vserver-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vserver-name
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vserver-name2
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ prov-status
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- neutron-network-id
+ in-maint
</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-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ is-closed-loop-disabled
</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-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
<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>
+ <a class="json-schema-ref" href="#/definitions/vservers">/vservers</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vserver">/vserver</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>create or update an existing vserver</p>
</section>
<section class="sw-request-body">
</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><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/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/vserver">/vserver</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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 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="#/definitions/vserver">/vserver</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
interface-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-id
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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">
+ <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">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>
+ <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>returns sriov-vfs</p>
+ <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 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="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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-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
+ cloud-owner
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ cloud-region-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ tenant-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ vserver-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>Name of the network</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>returns l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlans</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
</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
+ l3-interface-ipv6-address
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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. </p>
+ </p>
+ </div>
+ <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>
- vserver-name
+ cloud-owner
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ cloud-region-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ tenant-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ vserver-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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 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="#/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>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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-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
+ cloud-owner
</td>
<td>
- <p>Name of vserver</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ cloud-region-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ tenant-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ vserver-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ resource-version
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vlan</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship 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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing vlan</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing vlan</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- vlan-interface
+ cloud-owner
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ cloud-region-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<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
+ tenant-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ vserver-id
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ interface-name
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ pci-id
</td>
<td>
- <p>Name of vserver</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vserver-name2
+ vf-vlan-filter
</td>
<td>
- <p>Alternative name of vserver</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ vf-mac-filter
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</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
+ vf-vlan-strip
</td>
<td>
</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>
<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>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>returns 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>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>create or update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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><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/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <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 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="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- l3-interface-ipv4-address
+ cloud-owner
</td>
<td>
- <p>IP address</p>
+ <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>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns vlans</p>
</section>
<section class="sw-request-params">
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>
</tr>
<tr>
<td>
- vserver-name2
+ vlan-id-inner
</td>
<td>
- <p>Alternative name of vserver</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ vpn-key
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<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="#/definitions/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>
- 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
+ cloud-owner
</td>
<td>
- <p>ID of interface</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ cloud-region-id
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ tenant-id
</td>
<td>
- <p>Name of the network</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ vserver-id
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ vlan-interface
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>create or update an existing vlan</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>update an existing vlan</p>
</section>
<section class="sw-request-body">
</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><p>vlan object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>delete an existing vlan</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 volumes</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
</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
+ interface-name
</td>
<td>
- <p>Name of vserver</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ vlan-interface
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</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>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/volumes">/volumes</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>returns volume</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- volume-id
+ interface-name
</td>
<td>
- <p>Unique ID of block storage volume relative to the vserver.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cloud-type
+ vlan-interface
</td>
<td>
- <p>Type of the cloud (e.g., openstack)</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- owner-defined-type
+ l3-interface-ipv6-address
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- tenant-name
+ cloud-owner
</td>
<td>
- <p>Readable name of tenant</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-context
+ cloud-region-id
</td>
<td>
- <p>This field will store the tenant context.</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ tenant-id
</td>
<td>
- <p>Name of vserver</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name2
+ vserver-id
</td>
<td>
- <p>Alternative name of vserver</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- in-maint
+ vlan-interface
</td>
<td>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- is-closed-loop-disabled
+ l3-interface-ipv6-address
</td>
<td>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing volume</p>
+ <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>
- <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/v12/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">
</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
+ interface-name
</td>
<td>
- <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- tenant-id
+ vlan-interface
</td>
<td>
- <p>Unique id relative to the cloud-region.</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vserver-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Unique identifier for this vserver relative to its tenant</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- volume-id
+ resource-version
</td>
<td>
- <p>Unique ID of block storage volume relative to the vserver.</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing volume</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- volume-id
+ interface-name
</td>
<td>
- <p>Unique ID of block storage volume relative to the vserver.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vlan-interface
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- volume-id
+ interface-name
</td>
<td>
- <p>Unique ID of block storage volume relative to the vserver.</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- volume-id
+ interface-name
</td>
<td>
- <p>Unique ID of block storage volume relative to the vserver.</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>returns vip-ipv4-address-list</p>
+ <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>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
<td>path</td>
<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
+ vserver-id
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ vlan-interface
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vip-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)</p>
+ <p><p>relationship 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="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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>
</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">
+ <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">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>
+ <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>update an existing vip-ipv4-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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>
</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">
+ <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">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>
+ <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>delete an existing vip-ipv4-address-list</p>
+ <p>returns volumes</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vserver-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ volume-id
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/volumes">/volumes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/volume">/volume</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- vip-ipv4-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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>
</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">
+ <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">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>
+ <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>returns vip-ipv6-address-list</p>
+ <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 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="#/definitions/volume">/volume</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- vip-ipv6-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
<td>path</td>
<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
+ vserver-id
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ volume-id
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vip-ipv6-address-list</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- vip-ipv6-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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-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>
</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">
+ <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">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>
+ <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>update an existing vip-ipv6-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vip-ipv6-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <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>
</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">
+ <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 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>
+ <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 vip-ipv6-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vip-ipv6-address
+ tenant-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id relative to the cloud-region.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vserver-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Unique identifier for this vserver relative to its tenant</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- vip-ipv6-address
+ vip-ipv4-address
</td>
<td>
<p>IP address</p>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- vip-ipv6-address
+ vip-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>returns volume-groups</p>
+ <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 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="#/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>
<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
+ vip-ipv4-address
</td>
<td>
- <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns volume-group</p>
+ <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>
<tr>
<td>
- volume-group-id
+ vip-ipv4-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<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
+ resource-version
</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>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing volume-group</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)</p>
+ <p><p>relationship 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="#/definitions/volume-group">/volume-group</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- volume-group-id
+ vip-ipv4-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing volume-group</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- volume-group-id
+ vip-ipv4-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing volume-group</p>
+ <p>returns 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>
<tr>
<td>
- volume-group-id
+ vip-ipv6-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>create or update an existing vip-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)</p>
+ <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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- volume-group-id
+ vip-ipv6-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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 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="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- volume-group-id
+ vip-ipv6-address
</td>
<td>
- <p>Unique ID of volume-group.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">returns complex</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ <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>returns complex</p>
+ <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>
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- data-center-code
+ cloud-region-id
</td>
<td>
- <p>Data center code which can be an alternate way to identify a complex</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- complex-name
+ vip-ipv6-address
</td>
<td>
- <p>Gamma complex name for LCP instance.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- identity-url
+ resource-version
</td>
<td>
- <p>URL of the keystone identity service</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing complex</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureComplexesComplex.json)</p>
+ <p><p>relationship 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="#/definitions/complex">/complex</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <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-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </div>
- </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
+ cloud-region-id
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <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>
</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">
+ <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 complex</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ <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 complex</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ cloud-region-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 ctag-pools</p>
+ <p>returns volume-groups</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- data-center-code
+ 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>Data center code which can be an alternate way to identify a complex</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- complex-name
+ volume-group-name
</td>
<td>
- <p>Gamma complex name for LCP instance.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- identity-url
+ heat-stack-id
+ </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>
+ <tr>
+ <td>
+ vnf-type
</td>
<td>
- <p>URL of the keystone identity service</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/ctag-pools">/ctag-pools</a>
+ <a class="json-schema-ref" href="#/definitions/volume-groups">/volume-groups</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 ctag-pool</p>
+ <p>returns volume-group</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/ctag-pool">/ctag-pool</a>
+ <a class="json-schema-ref" href="#/definitions/volume-group">/volume-group</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 ctag-pool</p>
+ <p>create or update an existing volume-group</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)</p>
+ <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="#/definitions/ctag-pool">/ctag-pool</a>
+ <a class="json-schema-ref" href="#/definitions/volume-group">/volume-group</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 ctag-pool</p>
+ <p>update an existing volume-group</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>ctag-pool object that needs to be created or updated.</p>
+ <p><p>volume-group object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/volume-group">/volume-group</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 ctag-pool</p>
+ <p>delete an existing volume-group</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- physical-location-id
+ cloud-owner
</td>
<td>
- <p>Unique identifier for physical location, e.g., CLLI</p>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- target-pe
+ cloud-region-id
</td>
<td>
- <p>The Target provider edge router</p>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- availability-zone-name
+ volume-group-id
</td>
<td>
- <p>Name of the availability zone</p>
+ <p>Unique ID of volume-group.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns complexes</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/CloudInfrastructureComplexesComplex.json)</p>
- </p>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ data-center-code
+ </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>
+ <tr>
+ <td>
+ complex-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>
+ <tr>
+ <td>
+ identity-url
+ </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="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>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/complex">/complex</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</div>
</div>
- <span id="path--cloud-infrastructure-network-profiles-"></span>
- <div id="operation--cloud-infrastructure-network-profiles-get" class="swagger--panel-operation-get panel">
+ <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">returns network-profiles</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/network-profiles</strong></h3>
+ <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>returns network-profiles</p>
+ <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 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="#/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--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>
+ availability-zone-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/network-profiles">/network-profiles</a>
+ <a class="json-schema-ref" href="#/definitions/ctag-pools">/ctag-pools</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 network-profile</p>
+ <p>returns ctag-pool</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/network-profile">/network-profile</a>
+ <a class="json-schema-ref" href="#/definitions/ctag-pool">/ctag-pool</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 network-profile</p>
+ <p>create or update an existing ctag-pool</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)</p>
+ <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="#/definitions/network-profile">/network-profile</a>
+ <a class="json-schema-ref" href="#/definitions/ctag-pool">/ctag-pool</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
</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">
+ <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 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>
+ <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 network-profile</p>
+ <p>update an existing ctag-pool</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>network-profile object that needs to be created or updated.</p>
+ <p><p>ctag-pool object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/ctag-pool">/ctag-pool</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
</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">
+ <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 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>
+ <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 network-profile</p>
+ <p>delete an existing ctag-pool</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
</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">
+ <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/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
</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">
+ <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/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- nm-profile-name
+ physical-location-id
</td>
<td>
- <p>Unique name of network profile.</p>
+ <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>
</div>
</div>
- <span id="path--cloud-infrastructure-operational-environments-"></span>
- <div id="operation--cloud-infrastructure-operational-environments-get" class="swagger--panel-operation-get panel">
+ <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">returns operational-environments</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/operational-environments</strong></h3>
+ <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>returns operational-environments</p>
+ <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. </p>
+ </p>
+ </div>
+ <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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/operational-environments">/operational-environments</a>
+ <a class="json-schema-ref" href="#/definitions/network-profiles">/network-profiles</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 operational-environment</p>
+ <p>returns network-profile</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/operational-environment">/operational-environment</a>
+ <a class="json-schema-ref" href="#/definitions/network-profile">/network-profile</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 operational-environment</p>
+ <p>create or update an existing network-profile</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)</p>
+ <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="#/definitions/operational-environment">/operational-environment</a>
+ <a class="json-schema-ref" href="#/definitions/network-profile">/network-profile</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 operational-environment</p>
+ <p>update an existing network-profile</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>operational-environment object that needs to be created or updated.</p>
+ <p><p>network-profile object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/network-profile">/network-profile</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 operational-environment</p>
+ <p>delete an existing network-profile</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- operational-environment-id
+ nm-profile-name
</td>
<td>
- <p>UUID of an operational environment</p>
+ <p>Unique name of network profile.</p>
</td>
<td>path</td>
<td>
</div>
</div>
- <span id="path--cloud-infrastructure-pservers-"></span>
- <div id="operation--cloud-infrastructure-pservers-get" class="swagger--panel-operation-get panel">
+ <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 pservers</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers</strong></h3>
+ <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 pservers</p>
+ <p>returns operational-environments</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/pservers">/pservers</a>
+ <a class="json-schema-ref" href="#/definitions/operational-environments">/operational-environments</a>
</div>
</div>
</div>
</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">
+ <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 pserver</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ <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 pserver</p>
+ <p>returns operational-environment</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- hostname
+ operational-environment-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID of an operational environment</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/pserver">/pserver</a>
+ <a class="json-schema-ref" href="#/definitions/operational-environment">/operational-environment</a>
</div>
</div>
</div>
</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">
+ <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 pserver</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ <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 pserver</p>
+ <p>create or update an existing operational-environment</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserver.json)</p>
+ <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="#/definitions/pserver">/pserver</a>
+ <a class="json-schema-ref" href="#/definitions/operational-environment">/operational-environment</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- hostname
+ operational-environment-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID of an operational environment</p>
</td>
<td>path</td>
<td>
</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">
+ <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 pserver</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ <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 pserver</p>
+ <p>update an existing operational-environment</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>pserver object that needs to be created or updated.</p>
+ <p><p>operational-environment object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/operational-environment">/operational-environment</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- hostname
+ operational-environment-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID of an operational environment</p>
</td>
<td>path</td>
<td>
</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">
+ <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 pserver</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ <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 pserver</p>
+ <p>delete an existing operational-environment</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- hostname
+ operational-environment-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID of an operational environment</p>
</td>
<td>path</td>
<td>
</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">
+ <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">returns lag-interfaces</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces</strong></h3>
+ <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>returns lag-interfaces</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- hostname
+ operational-environment-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID of an operational environment</p>
</td>
<td>path</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>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ </td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
pserver-id
</td>
<td>
- <p>ID of Pserver</p>
</td>
<td>query</td>
<td>
pserver-name2
</td>
<td>
- <p>alternative pserver name</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/lag-interfaces">/lag-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/pservers">/pservers</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>returns pserver</p>
</section>
<section class="sw-request-params">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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. </p>
+ </p>
+ </div>
+ <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>
- interface-name
+ hostname
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- inv-status
+ hostname
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- pserver-id
+ hostname
</td>
<td>
- <p>ID of Pserver</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- in-maint
+ resource-version
</td>
<td>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- pserver-name2
+ interface-name
</td>
<td>
- <p>alternative pserver name</p>
</td>
<td>query</td>
<td>
interface-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ <a class="json-schema-ref" href="#/definitions/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>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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>
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)</p>
+ <p><p>lag-interface object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>lag-interface object that needs to be created or updated.</p>
+ <p><p>lag-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div></div>
</div>
</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
+ interface-name
</td>
<td>
- <p>ID of Pserver</p>
</td>
<td>query</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
+ interface-id
</td>
<td>
- <p>alternative pserver name</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ macaddr
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-role
+ network-name
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div>
</div>
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ <p><p>l-interface object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <p><p>l-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<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>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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">
</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><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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. </p>
+ </p>
+ </div>
+ <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>
- 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
+ hostname
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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 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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be updated.</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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 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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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">
<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>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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 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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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 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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns sriov-vfs</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ pci-id
+ </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>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </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>
+ <tr>
+ <td>
+ vf-mac-filter
+ </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>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </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>
+ neutron-network-id
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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-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>
+ <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-vfs</p>
+ <p>returns sriov-vf</p>
</section>
<section class="sw-request-params">
</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
+ pci-id
</td>
<td>
- <p>Name of the network</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div>
</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 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">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>
+ <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>returns sriov-vf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- 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
+ hostname
</td>
<td>
- <p>alternative pserver name</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ interface-name
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ pci-id
</td>
<td>
- <p>ID of interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- macaddr
+ hostname
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-vlan-filter
+ interface-name
</td>
<td>
- <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-mac-filter
+ pci-id
</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>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-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
+ resource-version
</td>
<td>
- <p>Neutron network id of the interface</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing sriov-vf</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship 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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</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">
+ <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">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>
+ <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>update an existing sriov-vf</p>
+ <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>
- <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">
</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">
+ <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">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>
+ <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>delete an existing sriov-vf</p>
+ <p>returns vlans</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>path</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>
<tr>
<td>
- resource-version
+ vlan-id-inner
+ </td>
+ <td>
+ </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>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns vlans</p>
+ <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 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="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</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
+ vlan-interface
</td>
<td>
- <p>Name of the network</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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 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">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>
+ <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>returns vlan</p>
+ <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>
<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
+ resource-version
</td>
<td>
- <p>ID of interface</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- interface-role
+ hostname
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Name of the network</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ l3-interface-ipv4-address
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- 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
+ hostname
</td>
<td>
- <p>ID of Pserver</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ interface-name
</td>
<td>
- <p>alternative pserver name</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ vlan-interface
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ l3-interface-ipv4-address
</td>
<td>
- <p>ID of interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- macaddr
+ hostname
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ vlan-interface
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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/v12/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">
<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>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns p-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
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>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>
<tr>
<td>
- l3-interface-ipv6-address
+ prov-status
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/p-interfaces">/p-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
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>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>create or update an existing p-interface</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
</div>
</div></div>
</div>
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>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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 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="#/definitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
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>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
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>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- pserver-id
+ interface-id
</td>
<td>
- <p>ID of Pserver</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- in-maint
+ macaddr
</td>
<td>
</td>
<td>query</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- pserver-name2
+ network-name
</td>
<td>
- <p>alternative pserver name</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/p-interfaces">/p-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>returns l-interface</p>
</section>
<section class="sw-request-params">
</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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>create or update an existing l-interface</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)</p>
+ <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="#/definitions/p-interface">/p-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
</tbody>
</table>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>update an existing l-interface</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>p-interface object that needs to be created or updated.</p>
+ <p><p>l-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
</tbody>
</table>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>delete an existing l-interface</p>
</section>
<section class="sw-request-body">
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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
</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">
+ <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 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>
+ <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 l-interfaces</p>
+ <p>returns l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-params">
</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
+ interface-name
</td>
<td>
- <p>alternative pserver name</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>returns l-interface</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l-interface</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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">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>
+ <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>update an existing l-interface</p>
+ <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>
- <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">
<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>
</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">
+ <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">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>
+ <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>delete an existing l-interface</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- resource-version
+ l3-interface-ipv4-address
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- 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
+ hostname
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- l3-interface-ipv6-address
+ hostname
</td>
<td>
- <p>IP address</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- pserver-id
+ interface-name
</td>
<td>
- <p>ID of Pserver</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- in-maint
+ hostname
</td>
<td>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- pserver-name2
+ interface-name
</td>
<td>
- <p>alternative pserver name</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ pci-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vf-vlan-filter
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vf-mac-filter
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ vf-vlan-strip
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<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>
<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>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- l3-interface-ipv6-address
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>create or update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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><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/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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 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="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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
+ pci-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 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>
+ <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 sriov-vfs</p>
+ <p>returns vlans</p>
</section>
<section class="sw-request-params">
</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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vlan-id-inner
</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-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vpn-key
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>returns vlan</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>create or update an existing vlan</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>update an existing vlan</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>vlan object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>delete an existing vlan</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- pci-id
+ vlan-interface
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <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>
</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">
+ <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">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>
+ <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>returns vlans</p>
+ <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 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="#/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>
<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
+ vlan-interface
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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>
<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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ resource-version
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vlan</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship 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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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">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>
+ <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>update an existing vlan</p>
+ <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>
- <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">
<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>
</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">
+ <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">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>
+ <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>delete an existing vlan</p>
+ <p>returns 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>
<tr>
<td>
- resource-version
+ l3-interface-ipv6-address
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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 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="#/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>
- inv-status
+ hostname
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- pserver-id
+ interface-name
</td>
<td>
- <p>ID of Pserver</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ interface-name
</td>
<td>
- <p>alternative pserver name</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ l3-interface-ipv6-address
</td>
<td>
- <p>ID of interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- macaddr
+ hostname
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ resource-version
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship 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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<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>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ hostname
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns sriov-pfs</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- interface-name
+ pf-pci-id
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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>
- vlan-interface
+ hostname
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Value from executing hostname on the compute node.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<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
+ pf-pci-id
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Identifier for the sriov-pf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>create or update an existing sriov-pf</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ pf-pci-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>update an existing sriov-pf</p>
</section>
<section class="sw-request-body">
</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><p>sriov-pf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ pf-pci-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>delete an existing sriov-pf</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ pf-pci-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ pf-pci-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ pf-pci-id
</td>
<td>
- <p>IP address</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
<tr>
<td>
- interface-name
+ vdc-id
</td>
<td>
- <p>Name that identifies the physical interface</p>
</td>
- <td>path</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>
<tr>
<td>
- interface-name
+ vdc-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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>
- vlan-interface
+ vdc-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>create or update an existing virtual-data-center</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)</p>
+ <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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/virtual-data-center">/virtual-data-center</a>
</div>
</div></div>
</div>
<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
+ vdc-id
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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 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="#/definitions/virtual-data-center">/virtual-data-center</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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
+ vdc-id
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns sriov-pfs</p>
+ <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>
<tbody>
<tr>
<td>
- hostname
+ vdc-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ resource-version
</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>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns sriov-pf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
+ vdc-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing sriov-pf</p>
+ <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>
- <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/v12/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">
<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
+ vdc-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Unique ID of the vdc</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>update an existing sriov-pf</p>
+ <p>returns configurations</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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>
<tbody>
<tr>
<td>
- hostname
+ configuration-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
</td>
- <td>path</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>
<tr>
<td>
- interface-name
+ model-invariant-id
</td>
<td>
- <p>Name that identifies the physical interface</p>
</td>
- <td>path</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>
<tr>
<td>
- pf-pci-id
+ model-version-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/configurations">/configurations</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>delete an existing sriov-pf</p>
+ <p>returns 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>
<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
+ configuration-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/configuration">/configuration</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>see node definition for valid relationships</p>
+ <p>create or update an existing configuration</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ <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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/configuration">/configuration</a>
</div>
</div></div>
</div>
<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
+ configuration-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>delete an existing relationship</p>
+ <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 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="#/definitions/configuration">/configuration</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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
+ configuration-id
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- hostname
+ configuration-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>delete an existing relationship</p>
+ <p>returns evcs</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
<tbody>
<tr>
<td>
- hostname
+ configuration-id
</td>
<td>
- <p>Value from executing hostname on the compute node.</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</td>
<td>
</table>
</section>
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </div>
- </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/virtual-data-centers">/virtual-data-centers</a>
+ <a class="json-schema-ref" href="#/definitions/evcs">/evcs</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>returns virtual-data-center</p>
+ <p>returns evc</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <p>UUID assigned to configuration.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vdc-name
+ evc-id
</td>
<td>
- <p>Name of the virtual data center</p>
+ <p>Unique/key field for the evc object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/virtual-data-center">/virtual-data-center</a>
+ <a class="json-schema-ref" href="#/definitions/evc">/evc</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>create or update an existing virtual-data-center</p>
+ <p>create or update an existing evc</p>
</section>
<section class="sw-request-body">
</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/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)</p>
+ <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="#/definitions/virtual-data-center">/virtual-data-center</a>
+ <a class="json-schema-ref" href="#/definitions/evc">/evc</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <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>
</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">
+ <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 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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>update an existing virtual-data-center</p>
+ <p>update an existing evc</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>virtual-data-center object that needs to be created or updated.</p>
+ <p><p>evc object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/evc">/evc</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <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>
</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">
+ <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 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>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
- <p>delete an existing virtual-data-center</p>
+ <p>delete an existing evc</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <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>
</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">
+ <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>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</strong></h3>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
</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/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <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>
</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">
+ <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>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</strong></h3>
+ <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-CloudInfrastructure">CloudInfrastructure</a>
+ <a href="#tag-Network">Network</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<tbody>
<tr>
<td>
- vdc-id
+ configuration-id
</td>
<td>
- <p>Unique ID of the vdc</p>
+ <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>
</div>
</div>
- <span id="path--network-configurations-"></span>
- <div id="operation--network-configurations-get" class="swagger--panel-operation-get panel">
+ <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 configurations</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations</strong></h3>
+ <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 configurations</p>
+ <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>
+ </tbody>
+ </table>
+ </section>
<section class="sw-responses">
<p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/configurations">/configurations</a>
+ <a class="json-schema-ref" href="#/definitions/forwarder-evcs">/forwarder-evcs</a>
</div>
</div>
</div>
</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">
+ <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 configuration</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ <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 configuration</p>
+ <p>returns forwarder-evc</p>
</section>
<section class="sw-request-params">
</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
+ forwarder-evc-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Key for forwarder-evc object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/configuration">/configuration</a>
+ <a class="json-schema-ref" href="#/definitions/forwarder-evc">/forwarder-evc</a>
</div>
</div>
</div>
</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">
+ <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 configuration</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ <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 configuration</p>
+ <p>create or update an existing forwarder-evc</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkConfigurationsConfiguration.json)</p>
+ <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="#/definitions/configuration">/configuration</a>
+ <a class="json-schema-ref" href="#/definitions/forwarder-evc">/forwarder-evc</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 configuration</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ <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 configuration</p>
+ <p>update an existing forwarder-evc</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>configuration object that needs to be created or updated.</p>
+ <p><p>forwarder-evc object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/forwarder-evc">/forwarder-evc</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 configuration</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ <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 configuration</p>
+ <p>delete an existing forwarder-evc</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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">returns evcs</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/evcs</strong></h3>
+ <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>returns evcs</p>
+ <p>see node definition for valid relationships</p>
</section>
- <section class="sw-request-params">
- <table class="table">
- <thead>
- <tr>
- <th class="sw-param-name"></th>
- <th class="sw-param-description"></th>
- <th class="sw-param-type"></th>
- <th class="sw-param-data-type"></th>
+ <section class="sw-request-body">
+
+ <p><span class="label 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. </p>
+ </p>
+ </div>
+ <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>
</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
+ forwarder-evc-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Key for forwarder-evc object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns evc</p>
+ <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>
<tr>
<td>
- evc-id
+ forwarder-evc-id
</td>
<td>
- <p>Unique/key field for the evc object</p>
+ <p>Key for forwarder-evc object</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- model-invariant-id
+ configuration-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>UUID assigned to configuration.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ metaname
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/evc">/evc</a>
+ <a class="json-schema-ref" href="#/definitions/metadata">/metadata</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing evc</p>
+ <p>returns 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>evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- evc-id
+ metaname
</td>
<td>
- <p>Unique/key field for the evc object</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing evc</p>
+ <p>create or update an existing metadatum</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>evc object that needs to be created or updated.</p>
+ <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/evc">/evc</a>
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- evc-id
+ metaname
</td>
<td>
- <p>Unique/key field for the evc object</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing evc</p>
+ <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 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="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- evc-id
+ metaname
</td>
<td>
- <p>Unique/key field for the evc object</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- evc-id
+ metaname
</td>
<td>
- <p>Unique/key field for the evc object</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">returns forwarder-evcs</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs</strong></h3>
+ <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>returns forwarder-evcs</p>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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
+ forwarding-path-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-version-id
+ forwarding-path-name
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarder-evcs">/forwarder-evcs</a>
+ <a class="json-schema-ref" href="#/definitions/forwarding-paths">/forwarding-paths</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 forwarder-evc</p>
+ <p>returns forwarding-path</p>
</section>
<section class="sw-request-params">
<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
+ forwarding-path-id
</td>
<td>
- <p>Key for forwarder-evc object</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarder-evc">/forwarder-evc</a>
+ <a class="json-schema-ref" href="#/definitions/forwarding-path">/forwarding-path</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 forwarder-evc</p>
+ <p>create or update an existing forwarding-path</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)</p>
+ <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="#/definitions/forwarder-evc">/forwarder-evc</a>
+ <a class="json-schema-ref" href="#/definitions/forwarding-path">/forwarding-path</a>
</div>
</div></div>
</div>
<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
+ forwarding-path-id
</td>
<td>
- <p>Key for forwarder-evc object</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 forwarder-evc</p>
+ <p>update an existing forwarding-path</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>forwarder-evc object that needs to be created or updated.</p>
+ <p><p>forwarding-path object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/forwarding-path">/forwarding-path</a>
</div>
</div></div>
</div>
<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
+ forwarding-path-id
</td>
<td>
- <p>Key for forwarder-evc object</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 forwarder-evc</p>
+ <p>delete an existing forwarding-path</p>
</section>
<section class="sw-request-body">
<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
+ forwarding-path-id
</td>
<td>
- <p>Key for forwarder-evc object</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns forwarders</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- forwarder-evc-id
+ sequence
</td>
<td>
- <p>Key for forwarder-evc object</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/forwarders">/forwarders</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- forwarder-evc-id
+ sequence
</td>
<td>
- <p>Key for forwarder-evc object</p>
+ <p>Unique ID of this segmentation</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/forwarder">/forwarder</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">returns metadata</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/metadata</strong></h3>
+ <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>returns metadata</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</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
+ sequence
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Unique ID of this segmentation</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">returns metadatum</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ <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>returns metadatum</p>
+ <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 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="#/definitions/forwarder">/forwarder</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ sequence
</td>
<td>
+ <p>Unique ID of this segmentation</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <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>
- 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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing metadatum</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ 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>
</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">
+ <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">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>
+ <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>update an existing metadatum</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>metadatum object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ sequence
</td>
<td>
+ <p>Unique ID of this segmentation</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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 metadatum</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ <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 metadatum</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- metaname
+ sequence
</td>
<td>
+ <p>Unique ID of this segmentation</p>
</td>
<td>path</td>
<td>
- <span class="json-property-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-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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/configurations/configuration/{configuration-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkConfigurationsConfiguration.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</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">
+ <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/configurations/configuration/{configuration-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- configuration-id
+ forwarding-path-id
</td>
<td>
- <p>UUID assigned to configuration.</p>
+ <p>Unique ID of this FP</p>
</td>
<td>path</td>
<td>
</div>
</div>
- <span id="path--network-forwarding-paths-"></span>
- <div id="operation--network-forwarding-paths-get" class="swagger--panel-operation-get panel">
+ <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 forwarding-paths</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths</strong></h3>
+ <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 forwarding-paths</p>
+ <p>returns generic-vnfs</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</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-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>
+ <tr>
+ <td>
+ vnf-name2
+ </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>
+ <tr>
+ <td>
+ vnf-type
+ </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>
+ <tr>
+ <td>
+ service-id
+ </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>
+ <tr>
+ <td>
+ regional-resource-zone
+ </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>
+ <tr>
+ <td>
+ prov-status
+ </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>
+ <tr>
+ <td>
+ heat-stack-id
+ </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>
+ <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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarding-paths">/forwarding-paths</a>
+ <a class="json-schema-ref" href="#/definitions/generic-vnfs">/generic-vnfs</a>
</div>
</div>
</div>
</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">
+ <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 forwarding-path</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ <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 forwarding-path</p>
+ <p>returns generic-vnf</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarding-path">/forwarding-path</a>
+ <a class="json-schema-ref" href="#/definitions/generic-vnf">/generic-vnf</a>
</div>
</div>
</div>
</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">
+ <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 forwarding-path</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ <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 forwarding-path</p>
+ <p>create or update an existing generic-vnf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkForwardingPathsForwardingPath.json)</p>
+ <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="#/definitions/forwarding-path">/forwarding-path</a>
+ <a class="json-schema-ref" href="#/definitions/generic-vnf">/generic-vnf</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 forwarding-path</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ <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 forwarding-path</p>
+ <p>update an existing generic-vnf</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>forwarding-path object that needs to be created or updated.</p>
+ <p><p>generic-vnf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/generic-vnf">/generic-vnf</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 forwarding-path</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ <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 forwarding-path</p>
+ <p>delete an existing generic-vnf</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 forwarders</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders</strong></h3>
+ <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 forwarders</p>
+ <p>returns entitlements</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- forwarding-path-name
+ group-uuid
+ </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>
+ <tr>
+ <td>
+ resource-uuid
</td>
<td>
- <p>Name of the FP</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarders">/forwarders</a>
+ <a class="json-schema-ref" href="#/definitions/entitlements">/entitlements</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 forwarder</p>
+ <p>returns entitlement</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- forwarding-path-name
+ resource-uuid
</td>
<td>
- <p>Name of the FP</p>
+ <p>Unique ID of an entitlement resource.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/forwarder">/forwarder</a>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 forwarder</p>
+ <p>create or update an existing entitlement</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)</p>
+ <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="#/definitions/forwarder">/forwarder</a>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 forwarder</p>
+ <p>update an existing entitlement</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>forwarder object that needs to be created or updated.</p>
+ <p><p>entitlement object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 forwarder</p>
+ <p>delete an existing entitlement</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-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>
</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">
+ <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/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-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>
</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">
+ <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/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- sequence
+ group-uuid
</td>
<td>
- <p>Unique ID of this segmentation</p>
+ <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">integer</span>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tbody>
<tr>
<td>
- forwarding-path-id
+ vnf-id
</td>
<td>
- <p>Unique ID of this FP</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-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>
+ <tr>
+ <td>
+ interface-id
+ </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>
+ <tr>
+ <td>
+ macaddr
+ </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>
+ <tr>
+ <td>
+ network-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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>returns 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>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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
<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>
</p>
<dl>
- <dt class="sw-response-default">
- default
+ <dt class="sw-response-200">
+ 200 OK
</dt>
- <dd class="sw-response-default">
+ <dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+ <p>successful operation</p>
</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>
+ <div class="panel panel-definition">
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>l-interface object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<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
<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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l-interface</p>
</section>
<section class="sw-request-body">
<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
+ vnf-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>Name of the network</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- vlan-id-inner
+ vnf-id
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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-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>
+ <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-ipv6-address-list</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv6-address-list</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<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
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv6-address-list</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
<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
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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}/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>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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}/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>
+ <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>
<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
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name given to the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name given to the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns sriov-vfs</p>
+ <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 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="#/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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name given to the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-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
+ vnf-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ l3-interface-ipv6-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>Name of the network</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns sriov-vf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name given to the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- pci-id
+ vnf-id
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<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
+ interface-name
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- widget-model-version
+ vnf-id
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ interface-name
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-function
+ vnf-id
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-role
+ interface-name
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-naming-code
+ vnf-id
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ pci-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ vf-vlan-filter
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vf-mac-filter
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vf-vlan-strip
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- vf-vlan-filter
+ neutron-network-id
</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>
<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="#/definitions/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>
- vf-mac-filter
+ vnf-id
</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>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-vlan-strip
+ interface-name
</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>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ pci-id
</td>
<td>
- <p>Neutron network id of the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div>
</div>
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>sriov-vf object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ <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>
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>sriov-vf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
<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
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ <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>
<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
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
<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
</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">
+ <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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- vnf-name
+ vlan-id-inner
</td>
<td>
- <p>Name of VNF.</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- vnf-name2
+ vpn-key
</td>
<td>
- <p>Alternate name of VNF.</p>
</td>
<td>query</td>
<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="#/definitions/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-type
+ vnf-id
</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>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-id
+ interface-name
</td>
<td>
- <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- regional-resource-zone
+ vlan-interface
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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. </p>
+ </p>
+ </div>
+ <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>
- prov-status
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ vlan-interface
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- in-maint
+ vnf-id
</td>
<td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- is-closed-loop-disabled
+ interface-name
</td>
<td>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">boolean</span>
+ <span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- model-version-id
+ vnf-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-id
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ vlan-interface
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ resource-version
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-function
+ vnf-id
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-role
+ interface-name
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ vlan-interface
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ l3-interface-ipv4-address
</td>
<td>
- <p>ID of interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- interface-role
+ vnf-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ vlan-interface
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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 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="#/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>
<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
</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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- regional-resource-zone
+ vnf-id
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ vlan-interface
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ l3-interface-ipv4-address
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- widget-model-id
+ vnf-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ vlan-interface
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-function
+ l3-interface-ipv4-address
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-role
+ vnf-id
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ interface-name
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ l3-interface-ipv4-address
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- interface-id
+ vnf-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Name of the network</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ l3-interface-ipv6-address
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-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
+ vnf-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ vlan-interface
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-function
+ l3-interface-ipv6-address
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- nf-role
+ vnf-id
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ interface-name
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- interface-role
+ vnf-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ vlan-interface
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ vnf-id
</td>
<td>
- <p>Name of the network</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- vpn-key
+ interface-id
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ interface-role
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <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="#/definitions/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>
- neutron-network-id
+ vnf-id
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ interface-name
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>create or update an existing lag-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>update an existing lag-interface</p>
</section>
<section class="sw-request-body">
</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><p>lag-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- interface-name
+ vnf-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-interface
+ interface-name
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
interface-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- vlan-interface
+ interface-id
</td>
<td>
- <p>String that identifies the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv4-address
+ macaddr
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
<tr>
<td>
- resource-version
+ network-name
</td>
<td>
- <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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 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="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- vlan-interface
+ vnf-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<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
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ resource-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>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-type
+ vnf-id
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-function
+ interface-name
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-role
+ interface-name
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ l3-interface-ipv4-address
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- interface-id
+ vnf-id
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ interface-name
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ l3-interface-ipv4-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- network-name
+ vnf-id
</td>
<td>
- <p>Name of the network</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</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
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</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
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">returns licenses</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses</strong></h3>
+ <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>returns licenses</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
+ interface-name
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ interface-name
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns license</p>
+ <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>
<tr>
<td>
- group-uuid
+ interface-name
</td>
<td>
- <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ interface-name
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-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
+ vnf-id
</td>
<td>
- <p>Alternate name of VNF.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</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>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-id
+ interface-name
</td>
<td>
- <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- regional-resource-zone
+ pci-id
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ vf-vlan-filter
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- heat-stack-id
+ vf-mac-filter
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</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
+ vf-vlan-strip
</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
+ neutron-network-id
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/license">/license</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing license</p>
+ <p>returns 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>license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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
+ interface-name
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ interface-name
</td>
<td>
- <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ pci-id
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing license</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- group-uuid
+ interface-name
</td>
<td>
- <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ interface-name
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ pci-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)</p>
+ <p><p>sriov-vf object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- group-uuid
+ interface-name
</td>
<td>
- <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ interface-name
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- group-uuid
+ interface-name
</td>
<td>
- <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ interface-name
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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-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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 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>
+ <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 vf-modules</p>
+ <p>returns vlans</p>
</section>
<section class="sw-request-params">
</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
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ interface-name
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-function
+ vlan-interface
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- nf-role
+ vlan-id-inner
</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-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- nf-naming-code
+ vpn-key
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vf-modules">/vf-modules</a>
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vf-module</p>
+ <p>returns vlan</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- vf-module-id
+ interface-name
</td>
<td>
- <p>Unique ID of vf-module.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<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
+ interface-name
</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>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-id
+ vlan-interface
</td>
<td>
- <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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. </p>
+ </p>
+ </div>
+ <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>
- regional-resource-zone
+ vnf-id
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ interface-name
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</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
+ vlan-interface
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- model-version-id
+ vnf-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-id
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-type
+ vlan-interface
</td>
<td>
- <p>Generic description of the type of NF</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- nf-function
+ vnf-id
</td>
<td>
- <p>English description of Network function that the specific VNF deployment is providing</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-role
+ interface-name
</td>
<td>
- <p>role in the network that this model will be providing</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- nf-naming-code
+ interface-name
</td>
<td>
- <p>string assigned to this model used for naming purposes</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ vlan-interface
</td>
<td>
- <p>Name of vf-module</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ resource-version
</td>
<td>
- <p>Heat stack id corresponding to this instance.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- model-invariant-id
+ vnf-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-id
+ interface-name
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ vlan-interface
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- contrail-service-instance-fqdn
+ l3-interface-ipv4-address
</td>
<td>
- <p>the Contrail unique ID for a service-instance</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vf-module">/vf-module</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vf-module</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)</p>
+ <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="#/definitions/vf-module">/vf-module</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vf-module-id
+ interface-name
</td>
<td>
- <p>Unique ID of vf-module.</p>
+ <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>
</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">
+ <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 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>
+ <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 vf-module</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vf-module object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vf-module-id
+ 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>Unique ID of vf-module.</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vf-module</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vf-module-id
+ interface-name
</td>
<td>
- <p>Unique ID of vf-module.</p>
+ <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>
</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">
+ <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}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- vf-module-id
+ interface-name
</td>
<td>
- <p>Unique ID of vf-module.</p>
+ <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>
</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">
+ <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}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- vf-module-id
+ interface-name
</td>
<td>
- <p>Unique ID of vf-module.</p>
+ <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>
</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">
+ <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 instance-group</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ <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 instance-group</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- description
+ interface-name
</td>
<td>
- <p>Descriptive text to help identify the usage of this instance-group</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- type
+ interface-name
</td>
<td>
- <p>Only valid value today is lower case ha for high availability</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- sub-type
+ vlan-interface
</td>
<td>
- <p>Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/instance-group">/instance-group</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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 instance-group</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ <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 instance-group</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkInstanceGroupsInstanceGroup.json)</p>
+ <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="#/definitions/instance-group">/instance-group</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <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>
</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">
+ <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 instance-group</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ <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 instance-group</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>instance-group object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <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>
</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">
+ <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 instance-group</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ <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 instance-group</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <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>
</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">
+ <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/instance-groups/instance-group/{id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkInstanceGroupsInstanceGroup.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <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>
</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">
+ <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/instance-groups/instance-group/{id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- id
+ vnf-id
</td>
<td>
- <p>Instance Group ID, UUID assigned to this instance.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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/v12/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
+ interface-name
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>update an existing ipsec-configuration</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>ipsec-configuration object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <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>
</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">
+ <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 ipsec-configuration</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</strong></h3>
+ <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 ipsec-configuration</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ interface-name
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <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>
</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">
+ <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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ 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>UUID of this configuration</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vig-servers</p>
+ <p>returns licenses</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ group-uuid
+ </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>
+ <tr>
+ <td>
+ resource-uuid
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vig-servers">/vig-servers</a>
+ <a class="json-schema-ref" href="#/definitions/licenses">/licenses</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vig-server</p>
+ <p>returns license</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vig-server">/vig-server</a>
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vig-server</p>
+ <p>create or update an existing license</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)</p>
+ <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="#/definitions/vig-server">/vig-server</a>
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
</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">
+ <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 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>
+ <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 vig-server</p>
+ <p>update an existing license</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vig-server object that needs to be created or updated.</p>
+ <p><p>license object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
</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">
+ <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 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>
+ <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 vig-server</p>
+ <p>delete an existing license</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
</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">
+ <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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
</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">
+ <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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- ipsec-configuration-id
+ vnf-id
</td>
<td>
- <p>UUID of this configuration</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vig-address-type
+ group-uuid
</td>
<td>
- <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <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>
</div>
</div>
- <span id="path--network-l3-networks-"></span>
- <div id="operation--network-l3-networks-get" class="swagger--panel-operation-get panel">
+ <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">returns l3-networks</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks</strong></h3>
+ <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>returns l3-networks</p>
+ <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. </p>
+ </p>
+ </div>
+ <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-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">returns l3-network</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}</strong></h3>
+ <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>returns l3-network</p>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ vnf-id
</td>
<td>
- <p>Name of the network, governed by some naming convention..</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-role
+ vf-module-id
</td>
<td>
- <p>Role the network plans - who defines these values?</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- service-id
+ vf-module-name
</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>
heat-stack-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- contrail-network-fqdn
+ model-invariant-id
</td>
<td>
- <p>Contrail FQDN for the network</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-invariant-id
+ model-version-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- model-version-id
+ widget-model-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- widget-model-id
+ widget-model-version
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- widget-model-version
+ contrail-service-instance-fqdn
</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l3-network">/l3-network</a>
+ <a class="json-schema-ref" href="#/definitions/vf-modules">/vf-modules</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing l3-network</p>
+ <p>returns 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>l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-network</p>
+ <p>create or update an existing vf-module</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l3-network object that needs to be created or updated.</p>
+ <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/l3-network">/l3-network</a>
+ <a class="json-schema-ref" href="#/definitions/vf-module">/vf-module</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <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>
</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">
+ <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">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>
+ <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>delete an existing l3-network</p>
+ <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 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="#/definitions/vf-module">/vf-module</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vf-module-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Unique ID of vf-module.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>returns ctag-assignments</p>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<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
+ vf-module-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Unique ID of vf-module.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ resource-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>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns ctag-assignment</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ vnf-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ vf-module-id
</td>
<td>
- <p>id.</p>
+ <p>Unique ID of vf-module.</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>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- widget-model-id
+ vnf-id
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-version
+ vf-module-id
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>Unique ID of vf-module.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing ctag-assignment</p>
+ <p>returns instance-groups</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
- <td>path</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>
<tr>
<td>
- vlan-id-inner
+ description
</td>
<td>
- <p>id.</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <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>
+ </td>
+ <td>query</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>
+ </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>
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/instance-groups">/instance-groups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing ctag-assignment</p>
+ <p>returns 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>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>
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
</td>
<td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing ctag-assignment</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
+ id
</td>
<td>
- <p>id.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing instance-group</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)</p>
+ <p><p>instance-group object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/instance-group">/instance-group</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
</td>
<td>path</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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing instance-group</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ resource-version
</td>
<td>
- <p>id.</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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/l3-networks/l3-network/{network-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkL3NetworksL3Network.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/l3-networks/l3-network/{network-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 segmentation-assignments</p>
+ <p>returns ipsec-configurations</p>
</section>
<section class="sw-request-params">
<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
+ ipsec-configuration-id
</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/segmentation-assignments">/segmentation-assignments</a>
+ <a class="json-schema-ref" href="#/definitions/ipsec-configurations">/ipsec-configurations</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 segmentation-assignment</p>
+ <p>returns ipsec-configuration</p>
</section>
<section class="sw-request-params">
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/segmentation-assignment">/segmentation-assignment</a>
+ <a class="json-schema-ref" href="#/definitions/ipsec-configuration">/ipsec-configuration</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 segmentation-assignment</p>
+ <p>create or update an existing ipsec-configuration</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)</p>
+ <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="#/definitions/segmentation-assignment">/segmentation-assignment</a>
+ <a class="json-schema-ref" href="#/definitions/ipsec-configuration">/ipsec-configuration</a>
</div>
</div></div>
</div>
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 segmentation-assignment</p>
+ <p>update an existing ipsec-configuration</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>segmentation-assignment object that needs to be created or updated.</p>
+ <p><p>ipsec-configuration object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/ipsec-configuration">/ipsec-configuration</a>
</div>
</div></div>
</div>
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 segmentation-assignment</p>
+ <p>delete an existing ipsec-configuration</p>
</section>
<section class="sw-request-body">
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</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">
+ <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/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</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">
+ <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/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</strong></h3>
+ <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>
<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
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
<div class="row">
<div class="col-md-12">
<p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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>
+
+ </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>
- model-version-id
+ ipsec-configuration-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>UUID of this configuration</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- widget-model-id
+ vig-address-type
</td>
<td>
- <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
</td>
<td>query</td>
<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="#/definitions/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>
- widget-model-version
+ ipsec-configuration-id
</td>
<td>
- <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <p>UUID of this configuration</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ vig-address-type
</td>
<td>
- <p>Name associated with the subnet.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/subnet">/subnet</a>
+ <a class="json-schema-ref" href="#/definitions/vig-server">/vig-server</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 subnet</p>
+ <p>create or update an existing vig-server</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)</p>
+ <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="#/definitions/subnet">/subnet</a>
+ <a class="json-schema-ref" href="#/definitions/vig-server">/vig-server</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- network-id
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- subnet-id
+ vig-address-type
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 subnet</p>
+ <p>update an existing vig-server</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>subnet object that needs to be created or updated.</p>
+ <p><p>vig-server object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vig-server">/vig-server</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- network-id
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- subnet-id
+ vig-address-type
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 subnet</p>
+ <p>delete an existing vig-server</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- network-id
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- subnet-id
+ vig-address-type
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns host-routes</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- subnet-id
+ vig-address-type
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns host-route</p>
+ <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>
<tbody>
<tr>
<td>
- network-id
+ ipsec-configuration-id
</td>
<td>
- <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <p>UUID of this configuration</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- subnet-id
+ vig-address-type
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
<tr>
<td>
- host-route-id
+ network-id
</td>
<td>
- <p>host-route id</p>
</td>
- <td>path</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>
<tr>
network-name
</td>
<td>
- <p>Name of the network, governed by some naming convention..</p>
</td>
<td>query</td>
<td>
network-role
</td>
<td>
- <p>Role the network plans - who defines these values?</p>
</td>
<td>query</td>
<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>
heat-stack-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
contrail-network-fqdn
</td>
<td>
- <p>Contrail FQDN for the network</p>
</td>
<td>query</td>
<td>
model-invariant-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<td>
model-version-id
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
</td>
<td>query</td>
<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>
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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/host-route">/host-route</a>
+ <a class="json-schema-ref" href="#/definitions/l3-networks">/l3-networks</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing host-route</p>
+ <p>returns 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>host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing host-route</p>
+ <p>create or update an existing l3-network</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>host-route object that needs to be created or updated.</p>
+ <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/host-route">/host-route</a>
+ <a class="json-schema-ref" href="#/definitions/l3-network">/l3-network</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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">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>
+ <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>delete an existing host-route</p>
+ <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 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="#/definitions/l3-network">/l3-network</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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
+ resource-version
</td>
<td>
- <p>host-route id</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns ctag-assignments</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
</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
+ vlan-id-inner
</td>
<td>
- <p>host-route id</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/ctag-assignments">/ctag-assignments</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- subnet-id
+ vlan-id-inner
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>id.</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- subnet-id
+ vlan-id-inner
</td>
<td>
- <p>Subnet ID, should be UUID.</p>
+ <p>id.</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</div>
</div>
- <span id="path--network-lag-links-"></span>
- <div id="operation--network-lag-links-get" class="swagger--panel-operation-get panel">
+ <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">returns lag-links</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/lag-links</strong></h3>
+ <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>returns lag-links</p>
+ <p>update an existing ctag-assignment</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">
+ <section class="sw-request-body">
+
+ <p><span class="label 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 updated.</p>
+ </p>
</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>
+ <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>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>Alphabetical concatenation of lag-interface names</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing lag-link</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- link-name
+ 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>Alphabetical concatenation of lag-interface names</p>
+ <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>
</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">
+ <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">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>
+ <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>update an existing lag-link</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>lag-link object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>Alphabetical concatenation of lag-interface names</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</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>
</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">
+ <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 lag-link</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/lag-links/lag-link/{link-name}</strong></h3>
+ <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 lag-link</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>Alphabetical concatenation of lag-interface names</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vlan-id-inner
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>id.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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/lag-links/lag-link/{link-name}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkLagLinksLagLink.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>Alphabetical concatenation of lag-interface names</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/lag-links/lag-link/{link-name}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>Alphabetical concatenation of lag-interface names</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</td>
<td>
</div>
</div>
- <span id="path--network-logical-links-"></span>
- <div id="operation--network-logical-links-get" class="swagger--panel-operation-get panel">
+ <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 logical-links</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/logical-links</strong></h3>
+ <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 logical-links</p>
+ <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>
+ segmentation-id
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/logical-links">/logical-links</a>
+ <a class="json-schema-ref" href="#/definitions/segmentation-assignments">/segmentation-assignments</a>
</div>
</div>
</div>
</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">
+ <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 logical-link</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ <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 logical-link</p>
+ <p>returns segmentation-assignment</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</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>
- 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
+ segmentation-id
</td>
<td>
- <p>Reason for this entity, role it is playing</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/logical-link">/logical-link</a>
+ <a class="json-schema-ref" href="#/definitions/segmentation-assignment">/segmentation-assignment</a>
</div>
</div>
</div>
</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">
+ <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 logical-link</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ <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 logical-link</p>
+ <p>create or update an existing segmentation-assignment</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkLogicalLinksLogicalLink.json)</p>
+ <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="#/definitions/logical-link">/logical-link</a>
+ <a class="json-schema-ref" href="#/definitions/segmentation-assignment">/segmentation-assignment</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <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>
</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">
+ <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 logical-link</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ <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 logical-link</p>
+ <p>update an existing segmentation-assignment</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>logical-link object that needs to be created or updated.</p>
+ <p><p>segmentation-assignment object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/segmentation-assignment">/segmentation-assignment</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <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>
</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">
+ <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 logical-link</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ <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 logical-link</p>
+ <p>delete an existing segmentation-assignment</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <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>
</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">
+ <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/logical-links/logical-link/{link-name}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkLogicalLinksLogicalLink.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <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>
</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">
+ <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/logical-links/logical-link/{link-name}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- link-name
+ network-id
</td>
<td>
- <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <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>
</div>
</div>
- <span id="path--network-multicast-configurations-"></span>
- <div id="operation--network-multicast-configurations-get" class="swagger--panel-operation-get panel">
+ <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 multicast-configurations</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/multicast-configurations</strong></h3>
+ <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 multicast-configurations</p>
+ <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>
+ subnet-id
+ </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>
+ <tr>
+ <td>
+ subnet-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/multicast-configurations">/multicast-configurations</a>
+ <a class="json-schema-ref" href="#/definitions/subnets">/subnets</a>
</div>
</div>
</div>
</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">
+ <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 multicast-configuration</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ <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 multicast-configuration</p>
+ <p>returns subnet</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/multicast-configuration">/multicast-configuration</a>
+ <a class="json-schema-ref" href="#/definitions/subnet">/subnet</a>
</div>
</div>
</div>
</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">
+ <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 multicast-configuration</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ <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 multicast-configuration</p>
+ <p>create or update an existing subnet</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)</p>
+ <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="#/definitions/multicast-configuration">/multicast-configuration</a>
+ <a class="json-schema-ref" href="#/definitions/subnet">/subnet</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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>
</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">
+ <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 multicast-configuration</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ <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 multicast-configuration</p>
+ <p>update an existing subnet</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>multicast-configuration object that needs to be created or updated.</p>
+ <p><p>subnet object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/subnet">/subnet</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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>
</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">
+ <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 multicast-configuration</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ <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 multicast-configuration</p>
+ <p>delete an existing subnet</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns host-routes</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ host-route-id
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/host-routes">/host-routes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
<tbody>
<tr>
<td>
- multicast-configuration-id
+ network-id
</td>
<td>
- <p>Unique id of multicast configuration.</p>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</div>
</div>
- <span id="path--network-network-policies-"></span>
- <div id="operation--network-network-policies-get" class="swagger--panel-operation-get panel">
+ <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">returns network-policies</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/network-policies</strong></h3>
+ <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>returns network-policies</p>
+ <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. </p>
+ </p>
+ </div>
+ <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-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns network-policy</p>
+ <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 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="#/definitions/host-route">/host-route</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- network-policy-fqdn
+ subnet-id
</td>
<td>
- <p>Contrail FQDN for the policy</p>
+ <p>Subnet ID, should be UUID.</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing network-policy</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <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-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>
</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">
+ <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">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>
+ <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>update an existing network-policy</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>network-policy object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <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>
</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">
+ <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 network-policy</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/network-policies/network-policy/{network-policy-id}</strong></h3>
+ <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 network-policy</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ subnet-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Subnet ID, should be UUID.</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkNetworkPoliciesNetworkPolicy.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <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>
</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">
+ <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/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- network-policy-id
+ network-id
</td>
<td>
- <p>UUID representing unique key to this instance</p>
+ <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>
</div>
</div>
- <span id="path--network-newvces-"></span>
- <div id="operation--network-newvces-get" class="swagger--panel-operation-get panel">
+ <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 newvces</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces</strong></h3>
+ <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 newvces</p>
+ <p>returns lag-links</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/newvces">/newvces</a>
+ <a class="json-schema-ref" href="#/definitions/lag-links">/lag-links</a>
</div>
</div>
</div>
</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">
+ <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 newvce</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ <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 newvce</p>
+ <p>returns lag-link</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/newvce">/newvce</a>
+ <a class="json-schema-ref" href="#/definitions/lag-link">/lag-link</a>
</div>
</div>
</div>
</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">
+ <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 newvce</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ <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 newvce</p>
+ <p>create or update an existing lag-link</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvce.json)</p>
+ <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="#/definitions/newvce">/newvce</a>
+ <a class="json-schema-ref" href="#/definitions/lag-link">/lag-link</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
<td>path</td>
<td>
</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">
+ <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 newvce</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ <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 newvce</p>
+ <p>update an existing lag-link</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>newvce object that needs to be created or updated.</p>
+ <p><p>lag-link object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/lag-link">/lag-link</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
<td>path</td>
<td>
</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">
+ <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 newvce</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ <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 newvce</p>
+ <p>delete an existing lag-link</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
<td>path</td>
<td>
</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">
+ <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">returns l-interfaces</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces</strong></h3>
+ <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>returns l-interfaces</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- 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
+ link-name
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Alphabetical concatenation of lag-interface names</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>returns logical-links</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vnf-id2
+ link-name
</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>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>
<tr>
<td>
- interface-name
+ model-invariant-id
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- vnf-name
+ model-version-id
</td>
<td>
- <p>Name of VNF.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vnf-name2
+ widget-model-id
</td>
<td>
- <p>Alternate name of VNF.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vnf-type
+ widget-model-version
</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>
prov-status
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- heat-stack-id
+ link-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ circuit-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ purpose
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<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="#/definitions/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>
- network-name
+ link-name
</td>
<td>
- <p>Name of the network</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/logical-link">/logical-link</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>create or update an existing logical-link</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)</p>
+ <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="#/definitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/logical-link">/logical-link</a>
</div>
</div></div>
</div>
<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
+ link-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>update an existing logical-link</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <p><p>logical-link object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/logical-link">/logical-link</a>
</div>
</div></div>
</div>
<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
+ link-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>delete an existing logical-link</p>
</section>
<section class="sw-request-body">
<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
+ link-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
+ link-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- l3-interface-ipv4-address
+ link-name
</td>
<td>
- <p>IP address</p>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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-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
+ multicast-configuration-id
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
</td>
<td>query</td>
<td>
<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>
+ <a class="json-schema-ref" href="#/definitions/multicast-configurations">/multicast-configurations</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>returns 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>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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
+ multicast-configuration-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>create or update an existing multicast-configuration</p>
</section>
<section class="sw-request-body">
</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><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/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/multicast-configuration">/multicast-configuration</a>
</div>
</div></div>
</div>
<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
+ multicast-configuration-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <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 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="#/definitions/multicast-configuration">/multicast-configuration</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
<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
+ multicast-configuration-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<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
+ multicast-configuration-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
+ multicast-configuration-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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>
<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
+ multicast-configuration-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of multicast configuration.</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns network-policies</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<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
+ network-policy-id
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ network-policy-fqdn
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/network-policies">/network-policies</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>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>
<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
+ network-policy-id
</td>
<td>
- <p>IP address</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
+ network-policy-id
</td>
<td>
- <p>IP address</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing network-policy</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>network-policy object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/network-policy">/network-policy</a>
</div>
</div></div>
</div>
<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
+ network-policy-id
</td>
<td>
- <p>IP address</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing network-policy</p>
</section>
<section class="sw-request-body">
<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
+ network-policy-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
+ network-policy-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</td>
<td>
</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">
+ <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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ <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>
<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
+ network-policy-id
</td>
<td>
- <p>Name given to the interface</p>
+ <p>UUID representing unique key to this instance</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vfs</p>
+ <p>returns newvces</p>
</section>
<section class="sw-request-params">
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>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>
<tr>
vnf-name
</td>
<td>
- <p>Name of VNF.</p>
</td>
<td>query</td>
<td>
vnf-name2
</td>
<td>
- <p>Alternate name of VNF.</p>
</td>
<td>query</td>
<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>
prov-status
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
<td>query</td>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/newvces">/newvces</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>returns newvce</p>
</section>
<section class="sw-request-params">
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/newvce">/newvce</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>create or update an existing newvce</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/newvce">/newvce</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>update an existing newvce</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>newvce object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/newvce">/newvce</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>delete an existing newvce</p>
</section>
<section class="sw-request-body">
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
interface-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- pci-id
+ interface-id
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>path</td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>returns vlans</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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-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
+ vnf-id2
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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>
<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
+ resource-version
</td>
<td>
- <p>ID of interface</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- macaddr
+ vnf-id2
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ l3-interface-ipv4-address
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)</p>
+ <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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-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
+ vnf-id2
</td>
<td>
- <p>ID of interface</p>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- 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
+ vnf-id2
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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-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>
+ <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-ipv4-address-list</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- vlan-interface
+ vnf-id2
</td>
<td>
- <p>String that identifies the interface</p>
+ <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>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name given to the interface</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns sriov-vfs</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ vf-vlan-filter
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>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>
<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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <p><p>sriov-vf object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns vlans</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ vlan-interface
+ </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>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ </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>
+ </td>
+ <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-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/physical-links">/physical-links</a>
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
</div>
</div>
</div>
</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">
+ <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 physical-link</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ <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 physical-link</p>
+ <p>returns vlan</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- link-name
+ vnf-id2
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <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>
</tr>
<tr>
<td>
- circuit-id
+ interface-name
</td>
<td>
- <p>Circuit it</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/physical-link">/physical-link</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div>
</div>
</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">
+ <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 physical-link</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ <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 physical-link</p>
+ <p>create or update an existing vlan</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPhysicalLinksPhysicalLink.json)</p>
+ <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="#/definitions/physical-link">/physical-link</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- link-name
+ vnf-id2
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <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>
</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">
+ <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 physical-link</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ <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 physical-link</p>
+ <p>update an existing vlan</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>physical-link object that needs to be created or updated.</p>
+ <p><p>vlan object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- link-name
+ vnf-id2
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <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>
</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">
+ <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 physical-link</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ <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 physical-link</p>
+ <p>delete an existing vlan</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- link-name
+ vnf-id2
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tbody>
<tr>
<td>
- link-name
+ vnf-id2
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <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-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</table>
</section>
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/pnfs">/pnfs</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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">returns pnf</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ <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>returns pnf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- pnf-name
+ 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>unique name of Physical Network Function.</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ l3-interface-ipv4-address
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing pnf</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnf.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/pnf">/pnf</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
</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">
+ <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">update an existing pnf</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ <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>update an existing pnf</p>
+ <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>
- <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">
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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-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>
</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">
+ <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">delete an existing pnf</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ <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>delete an existing pnf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
</tr>
<tr>
<td>
- resource-version
+ interface-name
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">returns lag-interfaces</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces</strong></h3>
+ <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>returns lag-interfaces</p>
+ <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>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ l3-interface-ipv6-address
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)</p>
+ <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="#/definitions/lag-interface">/lag-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>lag-interface object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>returns l-interfaces</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ l3-interface-ipv6-address
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns l-interface</p>
+ <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>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l-interface</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ <p><p>relationship 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="#/definitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l-interface</p>
+ <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>
- <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">
<tbody>
<tr>
<td>
- pnf-name
+ vnf-id2
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name given to the interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l-interface</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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
+ vnf-id2
</td>
<td>
- <p>Name given to the interface</p>
+ <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-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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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>
<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
+ vnf-id2
</td>
<td>
- <p>IP address</p>
+ <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-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
<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
+ link-name
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</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
+ circuit-id
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
</td>
<td>query</td>
<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="#/definitions/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>
- neutron-subnet-id
+ link-name
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/physical-link">/physical-link</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>create or update an existing physical-link</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/physical-link">/physical-link</a>
</div>
</div></div>
</div>
<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
+ link-name
</td>
<td>
- <p>IP address</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>update an existing physical-link</p>
</section>
<section class="sw-request-body">
</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><p>physical-link object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/physical-link">/physical-link</a>
</div>
</div></div>
</div>
<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
+ link-name
</td>
<td>
- <p>IP address</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>delete an existing physical-link</p>
</section>
<section class="sw-request-body">
<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
+ link-name
</td>
<td>
- <p>IP address</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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/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>
+ <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>
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
+ link-name
</td>
<td>
- <p>IP address</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
<td>path</td>
<td>
</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">
+ <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/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>
+ <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>
<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
+ link-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
<tr>
<td>
- interface-name
+ pnf-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv4-address
+ inv-status
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/pnfs">/pnfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns pnf</p>
</section>
<section class="sw-request-params">
<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>
<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>
+ <a class="json-schema-ref" href="#/definitions/pnf">/pnf</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>create or update an existing pnf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/pnf">/pnf</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>update an existing pnf</p>
</section>
<section class="sw-request-body">
</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><p>pnf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/pnf">/pnf</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>delete an existing pnf</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns lag-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
interface-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
</td>
- <td>path</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>
<tr>
<td>
- interface-name
+ interface-id
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-role
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-interfaces">/lag-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- interface-name
+ pnf-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing lag-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ <p><p>lag-interface object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
- <tr>
- <td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-type">string</span>
- <span class="json-property-range" title="Value limits"></span>
- </td>
- <td>
- <span class="json-property-required"></span>
- </td>
- </tr>
</tbody>
</table>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing lag-interface</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- interface-name
+ resource-version
</td>
<td>
- <p>Name given to the interface</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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 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>
+ <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 sriov-vfs</p>
+ <p>returns l-interfaces</p>
</section>
<section class="sw-request-params">
interface-name
</td>
<td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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>
interface-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
macaddr
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
network-name
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>returns l-interface</p>
</section>
<section class="sw-request-params">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- pci-id
+ pnf-name
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<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
+ interface-name
</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>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing sriov-vf</p>
+ <p>update an existing l-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>l-interface object that needs to be 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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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">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>
+ <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>update an existing sriov-vf</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- pci-id
+ resource-version
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing sriov-vf</p>
+ <p>returns 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>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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 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="#/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">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns vlans</p>
+ <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>
<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
+ l3-interface-ipv4-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>Name of the network</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vlan</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv4-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing vlan</p>
+ <p>returns 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>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>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing vlan</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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 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="#/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>
<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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
<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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- vlan-interface
+ l3-interface-ipv6-address
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</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
+ l3-interface-ipv6-address
</td>
<td>
<p>IP address</p>
<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>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns sriov-vfs</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ vf-vlan-filter
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
<tr>
<td>
- inv-status
+ vf-mac-filter
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ vf-vlan-strip
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- interface-role
+ neutron-network-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
</td>
<td>query</td>
<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="#/definitions/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>
- interface-id
+ pnf-name
</td>
<td>
- <p>ID of interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ pci-id
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- vpn-key
+ pnf-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ pci-id
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <p><p>sriov-vf object that needs to be 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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns vlans</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
vlan-interface
</td>
<td>
- <p>String that identifies the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ vlan-id-inner
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing vlan</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)</p>
+ <p><p>vlan object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing vlan</p>
</section>
<section class="sw-request-body">
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ 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>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>returns l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-params">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfPInterfacesPInterface.json)</p>
+ <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="#/definitions/p-interface">/p-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <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>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>p-interface object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <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>
</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">
+ <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 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>
+ <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 p-interface</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <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>
</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">
+ <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">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>
+ <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>returns l-interfaces</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns l-interface</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<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
+ vlan-interface
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l-interface</p>
+ <p>returns 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>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l-interface</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <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/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- pnf-name
+ 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>unique name of Physical Network Function.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name given to the interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l-interface</p>
+ <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 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="#/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">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vlan-interface
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ vlan-interface
</td>
<td>
- <p>IP address</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ l3-interface-ipv6-address
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ resource-version
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- interface-id
+ pnf-name
</td>
<td>
- <p>ID of interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ vlan-interface
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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/v12/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">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ 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>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ vlan-interface
</td>
<td>
- <p>IP address</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ vlan-interface
</td>
<td>
- <p>IP address</p>
+ <p>String that identifies the interface</p>
</td>
<td>path</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>
</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">
+ <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}/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>
+ <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>
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
interface-name
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- interface-name
+ pnf-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns p-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
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>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>
<tr>
<td>
- l3-interface-ipv4-address
+ prov-status
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/p-interfaces">/p-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns p-interface</p>
</section>
<section class="sw-request-params">
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- interface-name
+ pnf-name
</td>
<td>
- <p>Name given to the interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- 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
+ pnf-name
</td>
<td>
- <p>ID of interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ pnf-name
</td>
<td>
- <p>Name of the network</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ resource-version
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
interface-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv6-address
+ interface-id
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>l-interface object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l-interface</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns sriov-vfs</p>
+ <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 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="#/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>
<tr>
<td>
- inv-status
+ l3-interface-ipv4-address
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- prov-status
+ pnf-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv4-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns sriov-vf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- pci-id
+ l3-interface-ipv4-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- inv-status
+ pnf-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ l3-interface-ipv4-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ pnf-name
</td>
<td>
- <p>Name of the network</p>
+ <p>unique name of Physical Network Function.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-vlan-filter
+ interface-name
</td>
<td>
- <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-mac-filter
+ interface-name
</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>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron network id of the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <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="#/definitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns vlans</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns vlan</p>
+ <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>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- vlan-interface
+ pnf-name
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ pci-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vf-vlan-filter
</td>
<td>
- <p>MAC address for the interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vf-mac-filter
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vlan-id-inner
+ vf-vlan-strip
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- vpn-key
+ neutron-network-id
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing vlan</p>
+ <p>returns 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>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing vlan</p>
+ <p>create or update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <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/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing vlan</p>
+ <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 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="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
</section>
<section class="sw-request-params">
<table class="table">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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>
<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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<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
+ resource-version
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship 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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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">
</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
+ pci-id
</td>
<td>
- <p>IP address</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <p>returns vlans</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
vlan-interface
</td>
<td>
- <p>String that identifies the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv4-address
+ vlan-id-inner
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">string</span>
+ <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
+ vpn-key
</td>
<td>
- <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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 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="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- l3-interface-ipv6-address
+ pnf-name
</td>
<td>
- <p>IP address</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ vlan-interface
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ resource-version
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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><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-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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 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="#/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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>unique name of Physical Network Function.</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ vlan-interface
</td>
<td>
- <p>Name that identifies the physical interface</p>
+ <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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>returns sriov-pfs</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- inv-status
+ interface-name
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ vlan-interface
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns sriov-pf</p>
+ <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 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="#/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>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- inv-status
+ vlan-interface
</td>
<td>
- <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing sriov-pf</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>update an existing sriov-pf</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-pf object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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 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>
+ <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 sriov-pf</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ vlan-interface
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</tr>
<tr>
<td>
- pf-pci-id
+ interface-name
</td>
<td>
- <p>Identifier for the sriov-pf</p>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkPnfsPnf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</div>
</div>
- <span id="path--network-route-table-references-"></span>
- <div id="operation--network-route-table-references-get" class="swagger--panel-operation-get panel">
+ <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 route-table-references</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/route-table-references</strong></h3>
+ <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 route-table-references</p>
+ <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>
+ pf-pci-id
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/route-table-references">/route-table-references</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pfs">/sriov-pfs</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 route-table-reference</p>
+ <p>returns sriov-pf</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- route-table-reference-id
+ pnf-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- route-table-reference-fqdn
+ interface-name
</td>
<td>
- <p>FQDN entry in the route table.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/route-table-reference">/route-table-reference</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 route-table-reference</p>
+ <p>create or update an existing sriov-pf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkRouteTableReferencesRouteTableReference.json)</p>
+ <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="#/definitions/route-table-reference">/route-table-reference</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- route-table-reference-id
+ pnf-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <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>
</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">
+ <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 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>
+ <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 route-table-reference</p>
+ <p>update an existing sriov-pf</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>route-table-reference object that needs to be created or updated.</p>
+ <p><p>sriov-pf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- route-table-reference-id
+ pnf-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ pf-pci-id
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Identifier for the sriov-pf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- route-table-reference-id
+ pnf-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <p>Name that identifies the physical interface</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ pf-pci-id
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <p>Identifier for the sriov-pf</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing site-pair-set</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkSitePairSetsSitePairSet.json)</p>
+ <p><p>relationship 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="#/definitions/site-pair-set">/site-pair-set</a>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- site-pair-set-id
+ pnf-name
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ interface-name
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <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>
</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">
+ <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 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>
+ <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 site-pair-set</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- site-pair-set-id
+ pnf-name
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-version
+ interface-name
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkSitePairSetsSitePairSet.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- site-pair-set-id
+ pnf-name
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- site-pair-set-id
+ pnf-name
</td>
<td>
- <p>Unique id of site pair set.</p>
+ <p>unique name of Physical Network Function.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 routing-instances</p>
+ <p>returns route-table-references</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- site-pair-set-id
+ route-table-reference-id
</td>
<td>
- <p>Unique id of site pair set.</p>
</td>
- <td>path</td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-table-reference-fqdn
+ </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>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/routing-instances">/routing-instances</a>
+ <a class="json-schema-ref" href="#/definitions/route-table-references">/route-table-references</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 routing-instance</p>
+ <p>returns route-table-reference</p>
</section>
<section class="sw-request-params">
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/routing-instance">/routing-instance</a>
+ <a class="json-schema-ref" href="#/definitions/route-table-reference">/route-table-reference</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 routing-instance</p>
+ <p>create or update an existing route-table-reference</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)</p>
+ <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="#/definitions/routing-instance">/routing-instance</a>
+ <a class="json-schema-ref" href="#/definitions/route-table-reference">/route-table-reference</a>
</div>
</div></div>
</div>
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 routing-instance</p>
+ <p>update an existing route-table-reference</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>routing-instance object that needs to be created or updated.</p>
+ <p><p>route-table-reference object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/route-table-reference">/route-table-reference</a>
</div>
</div></div>
</div>
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 routing-instance</p>
+ <p>delete an existing route-table-reference</p>
</section>
<section class="sw-request-body">
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</strong></h3>
+ <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>
<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
+ route-table-reference-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
</td>
<td>path</td>
<td>
</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">
+ <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-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>
+ <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-pairs</p>
+ <p>returns site-pair-sets</p>
</section>
<section class="sw-request-params">
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>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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/site-pairs">/site-pairs</a>
+ <a class="json-schema-ref" href="#/definitions/site-pair-sets">/site-pair-sets</a>
</div>
</div>
</div>
</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">
+ <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</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>
+ <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</p>
+ <p>returns site-pair-set</p>
</section>
<section class="sw-request-params">
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/site-pair">/site-pair</a>
+ <a class="json-schema-ref" href="#/definitions/site-pair-set">/site-pair-set</a>
</div>
</div>
</div>
</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">
+ <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</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>
+ <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</p>
+ <p>create or update an existing site-pair-set</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)</p>
+ <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="#/definitions/site-pair">/site-pair</a>
+ <a class="json-schema-ref" href="#/definitions/site-pair-set">/site-pair-set</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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--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>
- routing-instance-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of routing instance</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- site-pair-id
+ resource-version
</td>
<td>
- <p>unique identifier of probe</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>update an existing site-pair</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>site-pair object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 site-pair</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<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>
</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">
+ <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 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>
+ <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 classes-of-service</p>
+ <p>returns routing-instances</p>
</section>
<section class="sw-request-params">
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>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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/classes-of-service">/classes-of-service</a>
+ <a class="json-schema-ref" href="#/definitions/routing-instances">/routing-instances</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 class-of-service</p>
+ <p>returns routing-instance</p>
</section>
<section class="sw-request-params">
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/class-of-service">/class-of-service</a>
+ <a class="json-schema-ref" href="#/definitions/routing-instance">/routing-instance</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 class-of-service</p>
+ <p>create or update an existing routing-instance</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)</p>
+ <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="#/definitions/class-of-service">/class-of-service</a>
+ <a class="json-schema-ref" href="#/definitions/routing-instance">/routing-instance</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 class-of-service</p>
+ <p>update an existing routing-instance</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>class-of-service object that needs to be created or updated.</p>
+ <p><p>routing-instance object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/routing-instance">/routing-instance</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 class-of-service</p>
+ <p>delete an existing routing-instance</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns site-pairs</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
site-pair-id
</td>
<td>
- <p>unique identifier of probe</p>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/site-pairs">/site-pairs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns 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>
</table>
</section>
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vces">/vces</a>
+ <a class="json-schema-ref" href="#/definitions/site-pair">/site-pair</a>
</div>
</div>
</div>
</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">
+ <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">returns vce</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ <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>returns vce</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<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
+ routing-instance-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Unique id of routing instance</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- vpe-id
+ site-pair-id
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
+ <p>unique identifier of probe</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing vce</p>
+ <p>update an existing site-pair</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVce.json)</p>
+ <p><p>site-pair object that needs to be 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="#/definitions/vce">/vce</a>
+ <a class="json-schema-ref" href="#/definitions/site-pair">/site-pair</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
- </tbody>
- </table>
- </section>
-
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
- <dt class="sw-response-default">
- default
-
- </dt>
- <dd class="sw-response-default">
- <div class="row">
- <div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
-
- </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
+ routing-instance-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <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>
</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">
+ <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 vce</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ <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 vce</p>
+ <p>delete an existing site-pair</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <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>
</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">
+ <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 entitlements</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/entitlements</strong></h3>
+ <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 entitlements</p>
+ <p>returns classes-of-service</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<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
+ routing-instance-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id of routing instance</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ site-pair-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>unique identifier of probe</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- vpe-id
+ cos
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/entitlements">/entitlements</a>
+ <a class="json-schema-ref" href="#/definitions/classes-of-service">/classes-of-service</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 entitlement</p>
+ <p>returns class-of-service</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <p>unique identifier of probe</p>
</td>
<td>path</td>
<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
+ cos
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
+ <p>unique identifier of probe</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/entitlement">/entitlement</a>
+ <a class="json-schema-ref" href="#/definitions/class-of-service">/class-of-service</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 entitlement</p>
+ <p>create or update an existing class-of-service</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVceEntitlementsEntitlement.json)</p>
+ <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="#/definitions/entitlement">/entitlement</a>
+ <a class="json-schema-ref" href="#/definitions/class-of-service">/class-of-service</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <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>
</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">
+ <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 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>
+ <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 entitlement</p>
+ <p>update an existing class-of-service</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>entitlement object that needs to be created or updated.</p>
+ <p><p>class-of-service object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/class-of-service">/class-of-service</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <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>
</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">
+ <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 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>
+ <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 entitlement</p>
+ <p>delete an existing class-of-service</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <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>
</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">
+ <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/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkVcesVceEntitlementsEntitlement.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <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>
</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">
+ <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/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ <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>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- group-uuid
+ routing-instance-id
</td>
<td>
- <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <p>Unique id of routing instance</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- resource-uuid
+ site-pair-id
</td>
<td>
- <p>Unique ID of an entitlement resource.</p>
+ <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>
</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">
+ <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">returns licenses</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/licenses</strong></h3>
+ <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>returns licenses</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- vnf-id
+ site-pair-set-id
</td>
<td>
- <p>Unique id of VNF. This is unique across the graph.</p>
+ <p>Unique id of site pair set.</p>
</td>
<td>path</td>
<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
+ routing-instance-id
</td>
<td>
- <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ <p>Unique id of routing instance</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- regional-resource-zone
+ site-pair-id
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
+ <p>unique identifier of probe</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- prov-status
+ site-pair-set-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id of site pair set.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ routing-instance-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Unique id of routing instance</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- vpe-id
+ site-pair-id
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
+ <p>unique identifier of probe</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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 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>
+ <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 license</p>
+ <p>returns vces</p>
</section>
<section class="sw-request-params">
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>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>
<tr>
vnf-name
</td>
<td>
- <p>Name of VNF.</p>
</td>
<td>query</td>
<td>
vnf-name2
</td>
<td>
- <p>Alternate name of VNF.</p>
</td>
<td>query</td>
<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>
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>
regional-resource-zone
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
</td>
<td>query</td>
<td>
prov-status
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
heat-stack-id
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
vpe-id
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/license">/license</a>
+ <a class="json-schema-ref" href="#/definitions/vces">/vces</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>create or update an existing license</p>
+ <p>returns 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>license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
- <dt class="sw-response-default">
- default
+ <dt class="sw-response-200">
+ 200 OK
</dt>
- <dd class="sw-response-default">
+ <dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
- <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+ <p>successful operation</p>
</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>
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vce">/vce</a>
+ </div>
+ </div>
+ </div>
- <section class="sw-responses">
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
-
- <dl>
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing license</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing vce</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVceLicensesLicense.json)</p>
+ <p><p>vce object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/vce">/vce</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing vce</p>
</section>
<section class="sw-request-body">
</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
+ resource-version
</td>
<td>
- <p>Unique ID of a license resource.</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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 port-groups</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/port-groups</strong></h3>
+ <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 port-groups</p>
+ <p>returns entitlements</p>
</section>
<section class="sw-request-params">
</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
+ group-uuid
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- vpe-id
+ resource-uuid
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/port-groups">/port-groups</a>
+ <a class="json-schema-ref" href="#/definitions/entitlements">/entitlements</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 port-group</p>
+ <p>returns entitlement</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
</td>
<td>path</td>
<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
+ resource-uuid
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Unique ID of an entitlement resource.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/port-group">/port-group</a>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 port-group</p>
+ <p>create or update an existing entitlement</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVcePortGroupsPortGroup.json)</p>
+ <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="#/definitions/port-group">/port-group</a>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <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>
</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">
+ <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 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>
+ <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 port-group</p>
+ <p>update an existing entitlement</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>port-group object that needs to be created or updated.</p>
+ <p><p>entitlement object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <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>
</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">
+ <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 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>
+ <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 port-group</p>
+ <p>delete an existing entitlement</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <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>
</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">
+ <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">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>
+ <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>returns cvlan-tags</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
</td>
<td>path</td>
<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
+ resource-uuid
</td>
<td>
- <p>Regional way of organizing pservers, source of truth should define values</p>
+ <p>Unique ID of an entitlement resource.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- prov-status
+ vnf-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ group-uuid
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- vpe-id
+ resource-uuid
</td>
<td>
- <p>Unique ID of VPE connected to this VCE.</p>
+ <p>Unique ID of an entitlement resource.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- port-group-id
+ vnf-id
</td>
<td>
- <p>Unique ID for port group in vmware</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ group-uuid
</td>
<td>
- <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- heat-stack-id
+ resource-uuid
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/cvlan-tags">/cvlan-tags</a>
+ <a class="json-schema-ref" href="#/definitions/licenses">/licenses</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 cvlan-tag-entry</p>
+ <p>returns license</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ resource-uuid
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
+ <p>Unique ID of a license resource.</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>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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. </p>
+ </p>
+ </div>
+ <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>
- port-group-id
+ vnf-id
</td>
<td>
- <p>Unique ID for port group in vmware</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ group-uuid
</td>
<td>
- <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- heat-stack-id
+ resource-uuid
</td>
<td>
- <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <p>Unique ID of a license resource.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing cvlan-tag-entry</p>
+ <p>update an existing license</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)</p>
+ <p><p>license object that needs to be 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="#/definitions/cvlan-tag-entry">/cvlan-tag-entry</a>
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ resource-uuid
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
+ <p>Unique ID of a license resource.</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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">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>
+ <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>update an existing cvlan-tag-entry</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ resource-uuid
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
+ <p>Unique ID of a license resource.</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>delete an existing cvlan-tag-entry</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ resource-uuid
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
+ <p>Unique ID of a license resource.</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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- interface-id
+ group-uuid
</td>
<td>
- <p>Unique ID of the interface</p>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- cvlan-tag
+ resource-uuid
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
+ <p>Unique ID of a license resource.</p>
</td>
<td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns port-groups</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
interface-id
</td>
<td>
- <p>Unique ID of the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- cvlan-tag
+ port-group-id
</td>
<td>
- <p>See mis-na-virtualization-platform.yang</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
- <span class="json-property-type">integer</span>
+ <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>
+ </td>
+ <td>query</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>
+ </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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/port-groups">/port-groups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing port-group</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVcesVce.json)</p>
+ <p><p>port-group object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/port-group">/port-group</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 relationship</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/relationship-list/relationship</strong></h3>
+ <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 relationship</p>
+ <p>delete an existing port-group</p>
</section>
<section class="sw-request-body">
<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>
</div>
</div>
- <span id="path--network-vnfcs-"></span>
- <div id="operation--network-vnfcs-get" class="swagger--panel-operation-get panel">
+ <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 vnfcs</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs</strong></h3>
+ <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 vnfcs</p>
+ <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>
+ cvlan-tag
+ </td>
+ <td>
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vnfcs">/vnfcs</a>
+ <a class="json-schema-ref" href="#/definitions/cvlan-tags">/cvlan-tags</a>
</div>
</div>
</div>
</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">
+ <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 vnfc</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ <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 vnfc</p>
+ <p>returns cvlan-tag-entry</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<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
+ interface-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
+ <p>Unique ID of the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ cvlan-tag
</td>
<td>
- <p>the ASDC model version for this resource or service model.</p>
+ <p>See mis-na-virtualization-platform.yang</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">string</span>
+ <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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vnfc">/vnfc</a>
+ <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">/cvlan-tag-entry</a>
</div>
</div>
</div>
</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">
+ <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 vnfc</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ <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 vnfc</p>
+ <p>create or update an existing cvlan-tag-entry</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVnfcsVnfc.json)</p>
+ <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="#/definitions/vnfc">/vnfc</a>
+ <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">/cvlan-tag-entry</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</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>
</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">
+ <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 vnfc</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ <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 vnfc</p>
+ <p>update an existing cvlan-tag-entry</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vnfc object that needs to be created or updated.</p>
+ <p><p>cvlan-tag-entry object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">/cvlan-tag-entry</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</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>
</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">
+ <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 vnfc</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ <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 vnfc</p>
+ <p>delete an existing cvlan-tag-entry</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</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
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique ID of the interface</p>
</td>
<td>path</td>
<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
+ cvlan-tag
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>See mis-na-virtualization-platform.yang</p>
</td>
- <td>query</td>
+ <td>path</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>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique ID of the interface</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</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><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique ID of the interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- vnfc-name
+ vnf-id
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique ID of the interface</p>
</td>
<td>path</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>
</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">
+ <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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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
+ vnf-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</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">
+ <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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ <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>
<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
+ vnf-id
</td>
<td>
- <p>IP address</p>
+ <p>Unique id of VNF. This is unique across the graph.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>returns vnfcs</p>
</section>
<section class="sw-request-params">
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>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>
<tr>
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>
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>
prov-status
</td>
<td>
- <p>prov status of this vnfc</p>
</td>
<td>query</td>
<td>
ipaddress-v4-oam-vip
</td>
<td>
- <p>Oam V4 vip address of this vnfc</p>
</td>
<td>query</td>
<td>
group-notation
</td>
<td>
- <p>Group notation of VNFC</p>
</td>
<td>query</td>
<td>
model-invariant-id
</td>
<td>
- <p>the ASDC model id for this resource or service model.</p>
</td>
<td>query</td>
<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>
<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="#/definitions/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>
- neutron-subnet-id
+ vnfc-name
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Unique ID of vnfc.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/vnfc">/vnfc</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv6-address-list</p>
+ <p>create or update an existing vnfc</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/vnfc">/vnfc</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- l3-interface-ipv6-address
+ vnfc-name
</td>
<td>
- <p>IP address</p>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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. </p>
+ </p>
+ </div>
+ <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>
- resource-version
+ vnfc-name
</td>
<td>
- <p>resource-version for concurrency</p>
+ <p>Unique ID of vnfc.</p>
</td>
- <td>query</td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
vnfc-name
</td>
<td>
- <p>Unique ID of vnfc.</p>
+ <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>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkVnfcsVnfc.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 vpls-pe</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ <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 vpls-pe</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
<tbody>
<tr>
<td>
- equipment-name
+ vnfc-name
</td>
<td>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ l3-interface-ipv6-address
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vpls-pe">/vpls-pe</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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 vpls-pe</div>
- <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ <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 vpls-pe</p>
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPe.json)</p>
+ <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="#/definitions/vpls-pe">/vpls-pe</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- equipment-name
+ 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>
</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">
+ <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 vpls-pe</div>
- <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ <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 vpls-pe</p>
+ <p>update an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vpls-pe object that needs to be created or updated.</p>
+ <p><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
<tbody>
<tr>
<td>
- equipment-name
+ 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>
</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">
+ <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 vpls-pe</div>
- <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ <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 vpls-pe</p>
+ <p>delete an existing l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-body">
<tbody>
<tr>
<td>
- equipment-name
+ vnfc-name
</td>
<td>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<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
+ l3-interface-ipv6-address
</td>
<td>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ resource-version
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns lag-interface</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tbody>
<tr>
<td>
- equipment-name
+ vnfc-name
</td>
<td>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>IP address</p>
</td>
<td>path</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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing lag-interface</p>
+ <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>
- <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/v12/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">
<tbody>
<tr>
<td>
- equipment-name
+ vnfc-name
</td>
<td>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- interface-name
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing lag-interface</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>lag-interface object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
<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
+ vnfc-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 lag-interface</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
<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
+ vnfc-name
</td>
<td>
- <p>Name that identifies the link aggregate interface</p>
+ <p>Unique ID of vnfc.</p>
</td>
<td>path</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>
</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">
+ <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 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>
+ <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 l-interfaces</p>
+ <p>returns vpls-pes</p>
</section>
<section class="sw-request-params">
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>
</tr>
<tr>
<td>
- interface-role
+ prov-status
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/vpls-pes">/vpls-pes</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>returns vpls-pe</p>
</section>
<section class="sw-request-params">
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/vpls-pe">/vpls-pe</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>create or update an existing vpls-pe</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ <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="#/definitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/vpls-pe">/vpls-pe</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>update an existing vpls-pe</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <p><p>vpls-pe object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vpls-pe">/vpls-pe</a>
</div>
</div></div>
</div>
<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>
</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">
+ <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 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>
+ <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 l-interface</p>
+ <p>delete an existing vpls-pe</p>
</section>
<section class="sw-request-body">
<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
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>returns lag-interfaces</p>
</section>
<section class="sw-request-params">
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>
interface-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<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>
<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="#/definitions/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>
- 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
+ equipment-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ interface-name
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 l3-interface-ipv4-address-list</p>
+ <p>create or update an existing lag-interface</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- interface-name
+ equipment-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-name
</td>
<td>
- <p>IP address</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <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>
- <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">
</tr>
<tr>
<td>
- interface-name
- </td>
- <td>
- <p>Name given to the interface</p>
- </td>
- <td>path</td>
- <td>
- <span class="json-property-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
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <p>returns l-interfaces</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
interface-name
</td>
<td>
- <p>Name given to the interface</p>
</td>
- <td>path</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>
<tr>
<td>
- l3-interface-ipv4-address
+ interface-id
</td>
<td>
- <p>IP address</p>
</td>
- <td>path</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>
<tr>
<td>
- resource-version
+ macaddr
+ </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>
+ <tr>
+ <td>
+ network-name
</td>
<td>
- <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
- <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>returns 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>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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>
<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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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 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="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<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>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing l3-interface-ipv6-address-list</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ resource-version
</td>
<td>
- <p>IP address</p>
+ <p>resource-version for concurrency</p>
</td>
- <td>path</td>
+ <td>query</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</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">
+ <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">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>
+ <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>update an existing l3-interface-ipv6-address-list</p>
+ <p>returns 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-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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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">
+ <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">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>
+ <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>delete an existing l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 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>
+ <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 sriov-vfs</p>
+ <p>returns l3-interface-ipv6-address-list</p>
</section>
<section class="sw-request-params">
</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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Name of the network</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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">
+ <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">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>
+ <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>returns sriov-vf</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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 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="#/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>
- 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
+ equipment-name
</td>
<td>
- <p>Name of the network</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-vlan-filter
+ interface-name
</td>
<td>
- <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-mac-filter
+ interface-name
</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>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-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
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron network id of the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing sriov-vf</p>
+ <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>
- <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/v12/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">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</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>
</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">
+ <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">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>
+ <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>update an existing sriov-vf</p>
+ <p>see node definition for valid relationships</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>relationship 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>
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 sriov-vf</p>
+ <p>delete an existing relationship</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- pci-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>PCI ID used to identify the sriov-vf</p>
+ <p>IP address</p>
</td>
<td>path</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>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
</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">
+ <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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ <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>
<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>
</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">
+ <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 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>
+ <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 vlans</p>
+ <p>returns sriov-vfs</p>
</section>
<section class="sw-request-params">
</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
+ pci-id
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-role
+ vf-vlan-filter
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ vf-mac-filter
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vf-vlan-strip
</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-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- network-name
+ neutron-network-id
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>returns sriov-vf</p>
</section>
<section class="sw-request-params">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div>
</div>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>create or update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <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="#/definitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>update an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <p><p>sriov-vf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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 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>
+ <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 vlan</p>
+ <p>delete an existing sriov-vf</p>
</section>
<section class="sw-request-body">
</tr>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- vlan-interface
+ pci-id
</td>
<td>
- <p>String that identifies the interface</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
<td>path</td>
<td>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- l3-interface-ipv4-address
+ equipment-name
</td>
<td>
- <p>IP address</p>
</td>
<td>path</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ pci-id
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>PCI ID used to identify the sriov-vf</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- interface-id
+ equipment-name
</td>
<td>
- <p>ID of interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ interface-name
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-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>Name of the network</p>
</td>
<td>query</td>
<td>
vlan-id-inner
</td>
<td>
- <p>Inner VLAN tag</p>
</td>
<td>query</td>
<td>
vpn-key
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
</td>
<td>query</td>
<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="#/definitions/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>
- vlan-id-inner
+ interface-name
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ vlan-interface
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div>
</div>
</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">
+ <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. </p>
+ </p>
+ </div>
+ <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">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>
+ <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>create or update an existing l3-interface-ipv4-address-list</p>
+ <p>update an existing vlan</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>vlan object that needs to be 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="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- l3-interface-ipv4-address
+ equipment-name
</td>
<td>
- <p>IP address</p>
</td>
<td>path</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>
</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 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">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>
+ <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>update an existing l3-interface-ipv4-address-list</p>
+ <p>returns 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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>delete an existing l3-interface-ipv4-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- prov-status
+ equipment-name
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- interface-role
+ interface-name
</td>
<td>
- <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ l3-interface-ipv4-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ equipment-name
</td>
<td>
- <p>Name of the network</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name that identifies the link aggregate interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ vlan-interface
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <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">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<span class="json-property-required"></span>
</td>
</tr>
+ <tr>
+ <td>
+ interface-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>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/p-interfaces">/p-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/p-interfaces">/p-interfaces</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)</p>
+ <p><p>p-interface object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>p-interface object that needs to be created or updated.</p>
+ <p><p>p-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- prov-status
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ interface-id
+ </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>
+ <tr>
+ <td>
+ macaddr
+ </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>
+ <tr>
+ <td>
+ network-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ <a class="json-schema-ref" href="#/definitions/l-interfaces">/l-interfaces</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ <p><p>l-interface object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>l-interface object that needs to be created or updated.</p>
+ <p><p>l-interface object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
</div>
</div></div>
</div>
<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>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <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>
</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">
+ <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">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>
+ <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>see node definition for valid relationships</p>
+ <p>update an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ <p><p>l3-interface-ipv4-address-list object that needs to be 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="#/definitions/relationship">/relationship</a>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</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">
+ <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 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>
+ <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 relationship</p>
+ <p>delete an existing l3-interface-ipv4-address-list</p>
</section>
<section class="sw-request-body">
<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>
</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">
+ <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">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>
+ <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>returns l3-interface-ipv6-address-list</p>
+ <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. </p>
+ </p>
+ </div>
+ <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>
<tr>
<td>
- l3-interface-ipv6-address
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- prov-status
+ equipment-name
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">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
+ interface-name
</td>
<td>
- <p>ID of interface</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- macaddr
+ l3-interface-ipv4-address
</td>
<td>
- <p>MAC address for the interface</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- network-name
+ equipment-name
</td>
<td>
- <p>Name of the network</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Inner VLAN tag</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
- <span class="json-property-type">integer</span>
+ <span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-network-id
+ interface-name
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <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">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</tr>
<tr>
<td>
- prov-status
+ pci-id
</td>
<td>
- <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- prov-status
+ vf-vlan-filter
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- interface-id
+ vf-mac-filter
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vf-vlan-strip
</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-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- network-name
+ neutron-network-id
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vfs">/sriov-vfs</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>sriov-vf object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-vf object that needs to be created or updated.</p>
+ <p><p>sriov-vf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ vlan-interface
</td>
<td>
- <p>ID of interface</p>
</td>
<td>query</td>
<td>
</tr>
<tr>
<td>
- macaddr
+ vlan-id-inner
</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-type">integer</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
</tr>
<tr>
<td>
- network-name
+ vpn-key
</td>
<td>
- <p>Name of the network</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ <a class="json-schema-ref" href="#/definitions/vlans">/vlans</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>vlan object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vlan object that needs to be created or updated.</p>
+ <p><p>vlan object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
</div>
</div></div>
</div>
<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>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <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">
</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><p>l3-interface-ipv4-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ l3-interface-ipv4-address
</td>
<td>
<p>IP address</p>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </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>
- 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
+ equipment-name
</td>
<td>
- <p>MAC address for the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ interface-name
</td>
<td>
- <p>Name of the network</p>
+ <p>Name that identifies the physical interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ interface-name
</td>
<td>
- <p>This indicates the customers VPN ID associated with this vlan</p>
+ <p>Name given to the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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>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
+ vlan-interface
</td>
<td>
- <p>Neutron network id of the interface that address belongs to</p>
+ <p>String that identifies the interface</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- neutron-subnet-id
+ l3-interface-ipv6-address
</td>
<td>
- <p>Neutron id of subnet that address belongs to</p>
+ <p>IP address</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <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">
</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><p>l3-interface-ipv6-address-list object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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
+ pf-pci-id
</td>
<td>
- <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-pfs">/sriov-pfs</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pfs">/sriov-pfs</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/sriov-pf">/sriov-pf</a>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ <p><p>sriov-pf object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>sriov-pf object that needs to be created or updated.</p>
+ <p><p>sriov-pf object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
</div>
</div></div>
</div>
</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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/NetworkVplsPesVplsPe.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns vpn-bindings</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</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-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>
+ <tr>
+ <td>
+ vpn-type
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vpn-bindings">/vpn-bindings</a>
+ <a class="json-schema-ref" href="#/definitions/vpn-bindings">/vpn-bindings</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vpn-binding">/vpn-binding</a>
+ <a class="json-schema-ref" href="#/definitions/vpn-binding">/vpn-binding</a>
</div>
</div>
</div>
</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/v12/NetworkVpnBindingsVpnBinding.json)</p>
+ <p><p>vpn-binding object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vpn-binding object that needs to be created or updated.</p>
+ <p><p>vpn-binding object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vpn-binding">/vpn-binding</a>
</div>
</div></div>
</div>
</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/v12/NetworkVpnBindingsVpnBinding.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/route-targets">/route-targets</a>
+ <a class="json-schema-ref" href="#/definitions/route-targets">/route-targets</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/route-target">/route-target</a>
+ <a class="json-schema-ref" href="#/definitions/route-target">/route-target</a>
</div>
</div>
</div>
</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/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)</p>
+ <p><p>route-target object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>route-target object that needs to be created or updated.</p>
+ <p><p>route-target object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/route-target">/route-target</a>
</div>
</div></div>
</div>
</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/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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">
+ <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">returns zone</div>
- <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/zones/zone/{zone-id}</strong></h3>
+ <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>returns zone</p>
+ <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>
<tbody>
<tr>
<td>
- zone-id
+ vpn-id
</td>
<td>
- <p>Code assigned by AIC to the zone</p>
+ <p>VPN ID, globally unique within A&AI</p>
</td>
<td>path</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-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
<tr>
<td>
design-type
</td>
<td>
- <p>Design of zone [Medium/Large…]</p>
</td>
<td>query</td>
<td>
zone-context
</td>
<td>
- <p>Context of zone [production/test]</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/zone">/zone</a>
+ <a class="json-schema-ref" href="#/definitions/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>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/zone">/zone</a>
</div>
</div>
</div>
</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/v12/NetworkZonesZone.json)</p>
+ <p><p>zone object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>zone object that needs to be created or updated.</p>
+ <p><p>zone object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/zone">/zone</a>
</div>
</div></div>
</div>
</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/v12/NetworkZonesZone.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns models</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</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-type
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/models">/models</a>
+ <a class="json-schema-ref" href="#/definitions/models">/models</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/model">/model</a>
+ <a class="json-schema-ref" href="#/definitions/model">/model</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationModelsModel.json)</p>
+ <p><p>model object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>model object that needs to be created or updated.</p>
+ <p><p>model object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/model">/model</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- model-type
+ model-version-id
+ </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>
+ <tr>
+ <td>
+ model-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>
+ <tr>
+ <td>
+ model-version
+ </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>
+ <tr>
+ <td>
+ distribution-status
</td>
<td>
- <p>Type of the model, e.g., service, resource, widget, etc.</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/model-vers">/model-vers</a>
+ <a class="json-schema-ref" href="#/definitions/model-vers">/model-vers</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/model-ver">/model-ver</a>
+ <a class="json-schema-ref" href="#/definitions/model-ver">/model-ver</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)</p>
+ <p><p>model-ver object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>model-ver object that needs to be created or updated.</p>
+ <p><p>model-ver object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/model-ver">/model-ver</a>
</div>
</div></div>
</div>
<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/v12/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>
</td>
<td>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>update an existing metadatum</p>
+ <p>returns 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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>delete an existing metadatum</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns model-elements</p>
+ <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 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="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
</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
+ metaname
</td>
<td>
- <p>Distribution Status</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>returns model-element</p>
+ <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>
<tr>
<td>
- model-element-uuid
+ metaname
</td>
<td>
</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
+ resource-version
</td>
<td>
- <p>Distribution Status</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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">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>
+ <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>create or update an existing model-element</p>
+ <p>returns model-elements</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label 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/v12/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>
</td>
<td>
</td>
- <td>path</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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/model-elements">/model-elements</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>update an existing model-element</p>
+ <p>returns 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>
</p>
<dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-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> </dd>
<dt class="sw-response-default">
default
</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 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">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>
+ <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>delete an existing model-element</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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">
+ <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">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>
+ <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>returns model-constraints</p>
+ <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 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="#/definitions/model-element">/model-element</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
<section class="sw-request-params">
<table class="table">
<thead>
<span class="json-property-required"></span>
</td>
</tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</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-type
+ model-invariant-id
</td>
<td>
- <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ model-version-id
</td>
<td>
- <p>Name of the model, which can change from version to version.</p>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ model-element-uuid
</td>
<td>
- <p>Version</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- distribution-status
+ resource-version
</td>
<td>
- <p>Distribution Status</p>
+ <p>resource-version for concurrency</p>
</td>
<td>query</td>
<td>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
</p>
<dl>
- <dt class="sw-response-200">
- 200 OK
-
- </dt>
- <dd class="sw-response-200">
- <div class="row">
- <div class="col-md-12">
- <p>successful operation</p>
-
- </div>
- </div>
- <div class="row">
-
- <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
</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">
+ <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-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>
+ <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-constraint</p>
+ <p>returns model-constraints</p>
</section>
<section class="sw-request-params">
</td>
<td>
</td>
- <td>path</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-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/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-type
+ model-invariant-id
</td>
<td>
- <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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-name
+ model-version-id
</td>
<td>
- <p>Name of the model, which can change from version to version.</p>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-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
+ model-element-uuid
</td>
<td>
- <p>Version</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
<tr>
<td>
- distribution-status
+ model-constraint-uuid
</td>
<td>
- <p>Distribution Status</p>
</td>
- <td>query</td>
+ <td>path</td>
<td>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</td>
<td>
+ <span class="json-property-required"></span>
</td>
</tr>
</tbody>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/model-constraint">/model-constraint</a>
+ <a class="json-schema-ref" href="#/definitions/model-constraint">/model-constraint</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)</p>
+ <p><p>model-constraint object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>model-constraint object that needs to be created or updated.</p>
+ <p><p>model-constraint object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/model-constraint">/model-constraint</a>
</div>
</div></div>
</div>
</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
+ constrained-element-set-uuid
</td>
<td>
- <p>Distribution Status</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/constrained-element-sets">/constrained-element-sets</a>
+ <a class="json-schema-ref" href="#/definitions/constrained-element-sets">/constrained-element-sets</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/constrained-element-set">/constrained-element-set</a>
+ <a class="json-schema-ref" href="#/definitions/constrained-element-set">/constrained-element-set</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)</p>
+ <p><p>constrained-element-set object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>constrained-element-set object that needs to be created or updated.</p>
+ <p><p>constrained-element-set object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/constrained-element-set">/constrained-element-set</a>
</div>
</div></div>
</div>
</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
+ element-choice-set-uuid
</td>
<td>
- <p>Distribution Status</p>
</td>
<td>query</td>
<td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/element-choice-sets">/element-choice-sets</a>
+ <a class="json-schema-ref" href="#/definitions/element-choice-sets">/element-choice-sets</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/element-choice-set">/element-choice-set</a>
+ <a class="json-schema-ref" href="#/definitions/element-choice-set">/element-choice-set</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)</p>
+ <p><p>element-choice-set object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>element-choice-set object that needs to be created or updated.</p>
+ <p><p>element-choice-set object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/element-choice-set">/element-choice-set</a>
</div>
</div></div>
</div>
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/ServiceDesignAndCreationModelsModel.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns named-queries</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/named-queries">/named-queries</a>
+ <a class="json-schema-ref" href="#/definitions/named-queries">/named-queries</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/named-query">/named-query</a>
+ <a class="json-schema-ref" href="#/definitions/named-query">/named-query</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)</p>
+ <p><p>named-query object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>named-query object that needs to be created or updated.</p>
+ <p><p>named-query object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/named-query">/named-query</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- named-query-name
+ named-query-element-uuid
</td>
<td>
</td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/named-query-elements">/named-query-elements</a>
+ <a class="json-schema-ref" href="#/definitions/named-query-elements">/named-query-elements</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/named-query-element">/named-query-element</a>
+ <a class="json-schema-ref" href="#/definitions/named-query-element">/named-query-element</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)</p>
+ <p><p>named-query-element object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>named-query-element object that needs to be created or updated.</p>
+ <p><p>named-query-element object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/named-query-element">/named-query-element</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- named-query-name
+ property-constraint-uuid
</td>
<td>
</td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/property-constraints">/property-constraints</a>
+ <a class="json-schema-ref" href="#/definitions/property-constraints">/property-constraints</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/property-constraint">/property-constraint</a>
+ <a class="json-schema-ref" href="#/definitions/property-constraint">/property-constraint</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)</p>
+ <p><p>property-constraint object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>property-constraint object that needs to be created or updated.</p>
+ <p><p>property-constraint object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/property-constraint">/property-constraint</a>
</div>
</div></div>
</div>
</tr>
<tr>
<td>
- named-query-name
+ related-lookup-uuid
</td>
<td>
</td>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/related-lookups">/related-lookups</a>
+ <a class="json-schema-ref" href="#/definitions/related-lookups">/related-lookups</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/related-lookup">/related-lookup</a>
+ <a class="json-schema-ref" href="#/definitions/related-lookup">/related-lookup</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)</p>
+ <p><p>related-lookup object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>related-lookup object that needs to be created or updated.</p>
+ <p><p>related-lookup object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/related-lookup">/related-lookup</a>
</div>
</div></div>
</div>
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <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. </p>
+ </p>
+ </div>
+ <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">
<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>
</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 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">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>
+ <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>see node definition for valid relationships</p>
+ <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>
- <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/v12/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">
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns service-capabilities</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
<tbody>
<tr>
<td>
- named-query-uuid
+ service-type
</td>
<td>
</td>
- <td>path</td>
+ <td>query</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>
+ </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-"></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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service-capabilities">/service-capabilities</a>
+ <a class="json-schema-ref" href="#/definitions/service-capabilities">/service-capabilities</a>
</div>
</div>
</div>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service-capability">/service-capability</a>
+ <a class="json-schema-ref" href="#/definitions/service-capability">/service-capability</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)</p>
+ <p><p>service-capability object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>service-capability object that needs to be created or updated.</p>
+ <p><p>service-capability object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/service-capability">/service-capability</a>
</div>
</div></div>
</div>
</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/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<p>returns services</p>
</section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <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>
+ </td>
+ <td>query</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-description
+ </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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/services">/services</a>
+ <a class="json-schema-ref" href="#/definitions/services">/services</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/service">/service</a>
+ <a class="json-schema-ref" href="#/definitions/service">/service</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationServicesService.json)</p>
+ <p><p>service object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>service object that needs to be created or updated.</p>
+ <p><p>service object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/service">/service</a>
</div>
</div></div>
</div>
</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/v12/ServiceDesignAndCreationServicesService.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</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">
+ <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">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>
+ <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>delete an existing relationship</p>
+ <p>returns vnf-images</p>
</section>
- <section class="sw-request-body">
-
- <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
- </p>
- </section>
<section class="sw-request-params">
<table class="table">
<thead>
<tbody>
<tr>
<td>
- service-id
+ vnf-image-uuid
</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>query</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>
+ </td>
+ <td>query</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>
+ </td>
+ <td>query</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>
+ </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-"></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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vnf-images">/vnf-images</a>
+ <a class="json-schema-ref" href="#/definitions/vnf-images">/vnf-images</a>
</div>
</div>
</div>
<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>
<div class="panel panel-definition">
<div class="panel-body">
- <a class="json-schema-ref" href="#/getDefinitions/vnf-image">/vnf-image</a>
+ <a class="json-schema-ref" href="#/definitions/vnf-image">/vnf-image</a>
</div>
</div>
</div>
</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/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)</p>
+ <p><p>vnf-image object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
</p>
<div class="row">
<div class="col-md-6">
- <p><p>vnf-image object that needs to be created or updated.</p>
+ <p><p>vnf-image object that needs to be 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>
+ <a class="json-schema-ref" href="#/definitions/vnf-image">/vnf-image</a>
</div>
</div></div>
</div>
</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/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)</p>
+ <p><p>relationship object that needs to be created or updated. </p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<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:
<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>
+<li>TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)</li>
+<li>TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)</li>
+<li>TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)</li>
+<li>TO l-interface( allotted-resource Uses l-interface, ONE2MANY)</li>
+<li>TO network-policy( allotted-resource Uses network-policy, ONE2ONE)</li>
+<li>TO vlan( allotted-resource PartOf vlan, MANY2MANY)</li>
+<li>TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)</li>
+<li>TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)</li>
+<li>TO model-ver( allotted-resource IsA model-ver, Many2One)</li>
+<li>FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)</li>
+<li>FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)</li>
+<li>FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)</li>
+<p></p>
+<li>(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also</li>
+<li>(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also</li>
+<li>(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also</li></ul>
</section>
<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>
+<li>TO complex( availability-zone LocatedIn complex, MANY2ONE)</li>
+<li>TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)</li>
+<li>TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)</li>
+<li>FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)</li>
+<li>FROM pserver( pserver MemberOf availability-zone, MANY2ONE)</li>
+<li>FROM vce( vce Uses availability-zone, MANY2MANY)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also</li>
+<li>AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE</li></ul>
</section>
<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>
+<li>TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also</li></ul>
</section>
</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>
-<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>
+<li>TO complex( cloud-region LocatedIn complex, MANY2ONE)</li>
+<li>TO l3-network( cloud-region Uses l3-network, MANY2MANY)</li>
+<li>TO zone( cloud-region LocatedIn zone, MANY2ONE)</li>
+<li>FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)</li>
+<li>FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)</li>
+<li>FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM image( image BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)</li>
+<li>FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also</li>
+<li>CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Whether the cloud region supports (true) or does not support (false) SR-IOV automation.</p>
+ <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>
<div class="json-inner-schema">
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="hpa-capabilities">
+ <span class="json-property-name">hpa-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/hpa-capability">hpa-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="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">esr-system-info</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
</div>
</section> </div>
</dd>
<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>
+<li>TO l3-network( complex Uses l3-network, MANY2MANY)</li>
+<li>FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)</li>
+<li>FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)</li>
+<li>FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)</li>
+<li>FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)</li>
+<li>FROM oam-network( oam-network AppliesTo complex, MANY2MANY)</li>
+<li>FROM pnf( pnf LocatedIn complex, MANY2ONE)</li>
+<li>FROM pserver( pserver LocatedIn complex, MANY2ONE)</li>
+<li>FROM vce( vce LocatedIn complex, MANY2MANY)</li>
+<li>FROM volume-group( volume-group LocatedIn complex, MANY2ONE)</li>
+<li>FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)</li>
+<li>FROM zone( zone LocatedIn complex, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this COMPLEX node is deleted, this FROM node is DELETED also</li>
+<li>COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE</li></ul>
</section>
</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>
-<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>
+<li>TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)</li>
+<li>TO logical-link( configuration Uses logical-link, ONE2MANY)(2)</li>
+<li>TO l-interface( configuration AppliesTo l-interface, ONE2MANY)</li>
+<li>TO pnf( configuration AppliesTo pnf, ONE2MANY)</li>
+<li>FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)</li>
+<li>FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)</li>
+<li>FROM service-instance( service-instance Uses configuration, ONE2MANY)</li>
+<li>FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)</li>
+<li>FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)</li>
+<li>FROM evc( evc BelongsTo configuration, ONE2ONE)(1)</li>
+<li>FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)</li>
+<p></p>
+<li>(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also</li>
+<li>(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also</li></ul>
</section>
<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>
<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>
<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>
<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>
<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>
+<li>TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)</li>
+<li>FROM service-instance( service-instance Uses connector, MANY2MANY)</li>
+<p></p>
+<li>(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)</li>
+<li>TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)</li>
+<li>FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also</li></ul>
</section>
<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>
+<li>TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)</li>
+<li>FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also</li></ul>
</section>
<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>
+<li>TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)</li>
+<li>TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)</li>
+<li>FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this CTAG-POOL is DELETED also</li></ul>
</section>
<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>
+<li>FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)</li>
+<li>FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO vce( entitlement BelongsTo vce, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also</li></ul>
</section>
<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>
+<li>FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)</li>
+<li>TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)</li>
+<li>TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)</li>
+<li>TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also</li></ul>
</section>
</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-type">object[]</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<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 class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<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>
+<li>TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)</li>
+<li>FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)</li>
+<p></p>
+<li>(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)</li>
+<p></p>
+<li>(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO configuration( evc BelongsTo configuration, ONE2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this EVC is DELETED also</li></ul>
</section>
<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>
+<li>TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)</li>
+<li>FROM vserver( vserver Uses flavor, MANY2ONE)</li>
+<p></p>
+<li>FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
- <p>Flavor name</p>
+ <p>Cloud region Flavor name</p>
<div class="json-inner-schema">
</div>
</div>
</dd>
+ <dt data-property-name="hpa-capabilities">
+ <span class="json-property-name">hpa-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/hpa-capability">hpa-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="relationship-list">
<span class="json-property-name">relationship-list:</span>
<span class="json-property-type">object[]</span>
<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>
+<li>TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)</li>
+<li>TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)</li>
+<li>TO configuration( forwarder Uses configuration, ONE2ONE)(2)</li>
+<li>TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)</li>
+<li>TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)</li>
+<p></p>
+<li>(2) IF this FORWARDER node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this FORWARDER is DELETED also</li></ul>
</section>
<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>
+<li>TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also</li></ul>
</section>
<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>
+<li>TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)</li>
+<li>TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)</li>
+<li>FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also</li></ul>
</section>
<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>
+<li>TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)</li>
+<li>TO complex( generic-vnf LocatedIn complex, MANY2MANY)</li>
+<li>TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)</li>
+<li>TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)</li>
+<li>TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)</li>
+<li>TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)</li>
+<li>TO l3-network( generic-vnf Uses l3-network, MANY2MANY)</li>
+<li>TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)</li>
+<li>TO pnf( generic-vnf HostedOn pnf, MANY2MANY)</li>
+<li>TO pserver( generic-vnf HostedOn pserver, MANY2MANY)</li>
+<li>TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)</li>
+<li>TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)</li>
+<li>TO vserver( generic-vnf HostedOn vserver, ONE2MANY)</li>
+<li>TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>TO model-ver( generic-vnf IsA model-ver, Many2One)</li>
+<li>FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)</li>
+<li>FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)</li>
+<li>FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)</li>
+<li>FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)</li>
+<li>FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)</li>
+<li>FROM platform( platform Uses generic-vnf, MANY2MANY)</li>
+<p></p>
+<li>(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also</li></ul>
</section>
<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>
<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">
<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>
<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>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether closed loop function is enabled on this node</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM pserver( pserver MemberOf group-assignment, MANY2ONE)</li>
+<li>FROM tenant( tenant MemberOf group-assignment, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also</li></ul>
</section>
</section>
</div>
</div>
+ <div id="definition-hpa-capabilities" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/hpa-capabilities"></a>hpa-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 HPA Capabilities</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="hpa-capability">
+ <span class="json-property-name">hpa-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/hpa-capability">hpa-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-hpa-capability" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/hpa-capability"></a>hpa-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>Represents a HPA capability</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)</li>
+<li>TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="hpa-capability-id">
+ <span class="json-property-name">hpa-capability-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 to uniquely identify a HPA capability</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="hpa-feature">
+ <span class="json-property-name">hpa-feature:</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 HPACapability</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="hpa-version">
+ <span class="json-property-name">hpa-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>HPA schema version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="architecture">
+ <span class="json-property-name">architecture:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Hardware architecture</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="hpa-feature-attributes">
+ <span class="json-property-name">hpa-feature-attributes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-feature-attributes">hpa-feature-attributes</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-hpa-feature-attributes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/hpa-feature-attributes"></a>hpa-feature-attributes:
+ <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>HPA Capability Feature attributes</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="hpa-attribute-key">
+ <span class="json-property-name">hpa-attribute-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>name of the specific HPA attribute</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="hpa-attribute-value">
+ <span class="json-property-name">hpa-attribute-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>JSON string specifying the value, unit and type of the specific HPA attribute</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-image" class="panel panel-definition">
<div class="panel-heading">
<h3 class="panel-title"><a name="/definitions/image"></a>image:
<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>
+<li>TO cloud-region( image BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)</li>
+<li>FROM vserver( vserver Uses image, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this IMAGE node is deleted, this FROM node is DELETED also</li>
+<li>IMAGE cannot be deleted if related to VSERVER</li></ul>
</section>
<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>
+<li>TO model( instance-group Targets model, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)</li>
+<li>FROM pnf( pnf MemberOf instance-group, MANY2MANY)</li>
+<li>FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)</li></ul>
</section>
<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>
<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>
<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>
</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-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<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 class="json-property-type"> <a class="json-schema-ref" href="#/definitions/nodes">nodes</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<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>
+<li>FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)</li>
+<li>FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)</li>
+<li>TO instance-group( l-interface MemberOf instance-group, MANY2MANY)</li>
+<li>TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)</li>
+<li>TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)</li>
+<li>TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)</li>
+<li>TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)</li>
+<li>TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)</li>
+<li>FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)</li>
+<li>FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)</li>
+<li>FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)</li>
+<li>FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)</li>
+<li>FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)</li>
+<li>FROM configuration( configuration AppliesTo l-interface, ONE2MANY)</li>
+<li>FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)</li>
+<li>FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)</li>
+<p></p>
+<li>(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this L-INTERFACE is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>boolean indicatating whether or not port is a mirrored.</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true)</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Flag indicating the interface uses the IP Unnumbered configuration.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)</li>
+<li>TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)</li>
+<li>TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)</li>
+<li>TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)</li>
+<li>TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also</li></ul>
</section>
<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>
+<li>TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)</li>
+<li>TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)</li>
+<li>TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)</li>
+<li>TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)</li>
+<li>TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also</li></ul>
</section>
<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>
+<li>TO instance-group( l3-network MemberOf instance-group, MANY2MANY)</li>
+<li>TO network-policy( l3-network Uses network-policy, MANY2MANY)</li>
+<li>TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)</li>
+<li>TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)</li>
+<li>TO model-ver( l3-network IsA model-ver, Many2One)</li>
+<li>FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)</li>
+<li>FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)</li>
+<li>FROM complex( complex Uses l3-network, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)</li>
+<li>FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)</li>
+<li>FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)</li>
+<li>FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)</li>
+<li>FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)</li>
+<li>FROM tenant( tenant Uses l3-network, MANY2MANY)</li>
+<li>FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)</li>
+<p></p>
+<li>(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Set to true if bound to VPN</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>boolean indicatating whether or not network is a provider network.</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>boolean indicatating whether or not network is a shared network.</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>boolean indicatating whether or not network is an external network.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)</li>
+<li>TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)</li>
+<li>TO p-interface( lag-interface Uses p-interface, MANY2MANY)</li>
+<li>TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)</li>
+<li>TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)</li>
+<li>TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)</li>
+<li>FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)</li>
+<li>FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true)</p>
<div class="json-inner-schema">
</div>
<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>
+<li>FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)</li>
+<li>FROM logical-link( logical-link Uses lag-link, MANY2MANY)</li>
+<p></p>
+<li>(3) IF this FROM node is deleted, this LAG-LINK is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO vce( license BelongsTo vce, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this LICENSE is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO l-interface( logical-link Source l-interface, ONE2MANY)(4)</li>
+<li>TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)</li>
+<li>TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)</li>
+<li>TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)</li>
+<li>TO lag-link( logical-link Uses lag-link, MANY2MANY)</li>
+<li>TO logical-link( logical-link Uses logical-link, MANY2MANY)</li>
+<li>TO pnf( logical-link BridgedTo pnf, MANY2MANY)</li>
+<li>TO pserver( logical-link BridgedTo pserver, MANY2MANY)</li>
+<li>TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)</li>
+<li>TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>TO model-ver( logical-link IsA model-ver, Many2One)</li>
+<li>FROM configuration( configuration Uses logical-link, ONE2MANY)(3)</li>
+<li>FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)</li>
+<li>FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)</li>
+<li>FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)</li>
+<li>FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)</li>
+<li>FROM vlan( vlan Uses logical-link, MANY2MANY)(3)</li>
+<li>FROM logical-link( logical-link Uses logical-link, MANY2MANY)</li>
+<p></p>
+<li>(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also</li>
+<li>(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)</li>
+<li>TO connector( metadatum BelongsTo connector, MANY2ONE)(4)</li>
+<li>TO image( metadatum BelongsTo image, MANY2ONE)(4)</li>
+<li>TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)</li>
+<li>TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this METADATUM is DELETED also</li></ul>
</section>
<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>
+<li>TO model( model-ver BelongsTo model, MANY2ONE)(1)</li>
+<li>FROM instance-group( instance-group Targets model, MANY2MANY)</li>
+<li>FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)</li>
+<li>FROM named-query( named-query AppliesTo model, ONE2MANY)</li>
+<li>FROM named-query-element( named-query-element IsA model, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this MODEL node is deleted, this FROM node is DELETED also</li>
+<li>MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT</li></ul>
</section>
<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>
+<li>TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)</li>
+<li>FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also</li></ul>
</section>
<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>
+<li>TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)</li>
+<li>TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)</li>
+<li>TO model-ver( model-element IsA model-ver, MANY2ONE)</li>
+<li>TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)</li>
+<li>FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)</li>
+<li>FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)</li>
+<li>FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)</li>
+<p></p>
+<li>(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also</li></ul>
</section>
<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>
+<li>TO model( model-ver BelongsTo model, MANY2ONE)(4)</li>
+<li>FROM model-element( model-element IsA model-ver, MANY2ONE)</li>
+<li>FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)</li>
+<li>FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)</li>
+<li>FROM allotted-resource( allotted-resource IsA model-ver, Many2One)</li>
+<li>FROM generic-vnf( generic-vnf IsA model-ver, Many2One)</li>
+<li>FROM l3-network( l3-network IsA model-ver, Many2One)</li>
+<li>FROM logical-link( logical-link IsA model-ver, Many2One)</li>
+<li>FROM service-instance( service-instance IsA model-ver, Many2One)</li>
+<li>FROM vf-module( vf-module IsA model-ver, Many2One)</li>
+<p></p>
+<li>(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this MODEL-VER is DELETED also</li>
+<li>MODEL-VER cannot be deleted if related to MODEL-ELEMENT</li></ul>
</section>
<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>
+<li>FROM vlan( vlan Uses multicast-configuration, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)</li>
+<li>TO model( named-query AppliesTo model, ONE2MANY)</li>
+<li>FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)</li>
+<p></p>
+<li>(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)</li>
+<li>TO model( named-query-element IsA model, MANY2ONE)</li>
+<li>TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)</li>
+<li>FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)</li>
+<li>FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)</li>
+<li>FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)</li>
+<p></p>
+<li>(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also</li></ul>
</section>
<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>
+<li>FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)</li>
+<li>FROM l3-network( l3-network Uses network-policy, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)</li></ul>
</section>
<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>
+<li>FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this NEWVCE node is deleted, this FROM node is DELETED also</li></ul>
</section>
</section>
</div>
</div>
+ <div id="definition-nodes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/nodes"></a>nodes:
+ <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-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>
+ </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:
<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>
+<li>TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO complex( oam-network AppliesTo complex, MANY2MANY)</li>
+<li>TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)</li>
+<li>FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)</li></ul>
</section>
<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>
+<li>FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)</li></ul>
</section>
<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>
+<li>TO logical-link( p-interface LinksTo logical-link, MANY2ONE)</li>
+<li>TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)</li>
+<li>TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)</li>
+<li>TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)</li>
+<li>TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)</li>
+<li>FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)</li>
+<li>FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)</li>
+<li>FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)</li>
+<li>FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this P-INTERFACE is DELETED also</li></ul>
</section>
</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-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true)</p>
<div class="json-inner-schema">
</div>
<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>
+<li>FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)</li>
+<p></p>
+<li>(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( platform Uses generic-vnf, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO complex( pnf LocatedIn complex, MANY2ONE)</li>
+<li>TO instance-group( pnf MemberOf instance-group, MANY2MANY)</li>
+<li>TO zone( pnf LocatedIn zone, MANY2ONE)</li>
+<li>FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)</li>
+<li>FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)</li>
+<li>FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)</li>
+<li>FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)</li>
+<li>FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)</li>
+<li>FROM configuration( configuration AppliesTo pnf, ONE2MANY)</li>
+<p></p>
+<li>(1) IF this PNF node is deleted, this FROM node is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO vce( port-group BelongsTo vce, MANY2ONE)(4)</li>
+<li>FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this PORT-GROUP is DELETED also</li></ul>
</section>
<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>
+<li>TO service-instance( project Uses service-instance, ONE2MANY)</li></ul>
</section>
<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>
+<li>TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also</li></ul>
</section>
<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>
+<li>TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)</li>
+<li>TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)</li>
+<li>TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)</li>
+<li>TO complex( pserver LocatedIn complex, MANY2ONE)</li>
+<li>TO zone( pserver LocatedIn zone, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)</li>
+<li>FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)</li>
+<li>FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)</li>
+<li>FROM vserver( vserver HostedOn pserver, MANY2ONE)</li>
+<p></p>
+<li>(1) IF this PSERVER node is deleted, this FROM node is DELETED also</li>
+<li>PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also</li></ul>
</section>
<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>
+<li>FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also</li></ul>
</section>
<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>
+<li>TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)</li>
+<li>FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also</li></ul>
</section>
<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>
+<li>TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also</li></ul>
</section>
<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>
+<li>FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)</li>
+<li>FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)</li>
+<p></p>
+<li>SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK</li></ul>
</section>
<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>
+<li>TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)</li>
+<li>TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)</li>
+<li>TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)</li>
+<li>TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)</li>
+<li>TO configuration( service-instance Uses configuration, ONE2MANY)</li>
+<li>TO connector( service-instance Uses connector, MANY2MANY)</li>
+<li>TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)</li>
+<li>TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)</li>
+<li>TO instance-group( service-instance MemberOf instance-group, MANY2MANY)</li>
+<li>TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)</li>
+<li>TO pnf( service-instance ComposedOf pnf, ONE2MANY)</li>
+<li>TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)</li>
+<li>TO vlan( service-instance ComposedOf vlan, ONE2MANY)</li>
+<li>TO zone( service-instance LocatedIn zone, MANY2ONE)</li>
+<li>TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)</li>
+<li>TO vce( service-instance ComposedOf vce, ONE2MANY)</li>
+<li>TO model-ver( service-instance IsA model-ver, Many2One)</li>
+<li>FROM project( project Uses service-instance, ONE2MANY)</li>
+<li>FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)</li>
+<li>FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)</li>
+<li>FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)</li>
+<li>FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)</li>
+<p></p>
+<li>(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also</li></ul>
</section>
<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>
<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>
<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>
<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>
<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>
<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>
+<li>TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)</li>
+<li>TO tenant( service-subscription Uses tenant, MANY2MANY)</li>
+<li>FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also</li></ul>
</section>
<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>
+<li>TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)</li>
+<li>FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this SITE-PAIR is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vserver( vserver Uses snapshot, ONE2ONE)</li></ul>
</section>
<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>
+<li>TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)</li>
+<li>FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this SRIOV-PF is DELETED also</li></ul>
</section>
<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>
+<li>TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)</li>
+<li>TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this SRIOV-VF is DELETED also</li></ul>
</section>
<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>
+<li>TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)</li>
+<li>FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)</li>
+<p></p>
+<li>(1) IF this SUBNET node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this SUBNET is DELETED also</li>
+<li>SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>dhcp enabled</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)</li>
+<li>TO l3-network( tenant Uses l3-network, MANY2MANY)</li>
+<li>TO volume-group( tenant DependsOn volume-group, ONE2MANY)</li>
+<li>FROM service-subscription( service-subscription Uses tenant, MANY2MANY)</li>
+<li>FROM vserver( vserver BelongsTo tenant, MANY2ONE)</li>
+<p></p>
+<li>TENANT cannot be deleted if related to VSERVER</li></ul>
</section>
<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>
+<li>TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also</li></ul>
</section>
<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>
+<li>TO availability-zone( vce Uses availability-zone, MANY2MANY)</li>
+<li>TO complex( vce LocatedIn complex, MANY2MANY)</li>
+<li>TO vserver( vce HostedOn vserver, ONE2MANY)</li>
+<li>FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)</li>
+<li>FROM license( license BelongsTo vce, MANY2ONE)(1)</li>
+<li>FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)</li>
+<li>FROM service-instance( service-instance ComposedOf vce, ONE2MANY)</li>
+<p></p>
+<li>(1) IF this VCE node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO l3-network( vf-module DependsOn l3-network, MANY2MANY)</li>
+<li>TO vnfc( vf-module Uses vnfc, ONE2MANY)</li>
+<li>TO volume-group( vf-module Uses volume-group, ONE2ONE)</li>
+<li>TO vserver( vf-module Uses vserver, ONE2MANY)</li>
+<li>TO model-ver( vf-module IsA model-ver, Many2One)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this VF-MODULE is DELETED also</li>
+<li>VF-MODULE cannot be deleted if related to VNFC</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is base vf module</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)</li>
+<p></p>
+<li>(4) IF this TO node is deleted, this VIG-SERVER is DELETED also</li></ul>
</section>
<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>
+<li>TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)</li>
+<li>FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)</li>
+<li>TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)</li>
+<li>FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)</li></ul>
</section>
<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>
+<li>FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)</li></ul>
</section>
<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>
+<li>TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)</li>
+<li>TO logical-link( vlan Uses logical-link, MANY2MANY)(2)</li>
+<li>TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)</li>
+<li>FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this VLAN node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this VLAN node is deleted, this TO node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this VLAN is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true)</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Flag indicating the interface uses the IP Unnumbered configuration.</p>
<div class="json-inner-schema">
</div>
<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>
+<li>FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)</li>
+<p></p>
+<li>VNF-IMAGE cannot be deleted if related to GENERIC-VNF</li></ul>
</section>
<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>
+<li>TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)</li>
+<li>TO instance-group( vnfc MemberOf instance-group, MANY2MANY)</li>
+<li>TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)</li>
+<li>TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)</li>
+<li>TO vserver( vnfc HostedOn vserver, ONE2MANY)</li>
+<li>FROM vf-module( vf-module Uses vnfc, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this VNFC node is deleted, this FROM node is DELETED also</li>
+<li>(4) IF this TO node is deleted, this VNFC is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether or not this object is in maintenance mode (maintenance mode = true)</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>used to indicate whether closed loop function is enabled on this node</p>
<div class="json-inner-schema">
</div>
<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>
+<li>FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)</li>
+<p></p>
+<li>(3) IF this FROM node is deleted, this VOLUME is DELETED also</li></ul>
</section>
<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>
+<li>TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO complex( volume-group LocatedIn complex, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)</li>
+<li>FROM vf-module( vf-module Uses volume-group, ONE2ONE)</li>
+<li>FROM tenant( tenant DependsOn volume-group, ONE2MANY)</li></ul>
</section>
<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>
+<li>TO complex( vpls-pe LocatedIn complex, MANY2ONE)</li>
+<li>TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)</li>
+<li>FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also</li></ul>
</section>
<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>
+<li>FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)</li>
+<li>FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)</li>
+<li>FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)</li>
+<li>FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)</li>
+<p></p>
+<li>(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also</li>
+<li>VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK</li></ul>
</section>
<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>
+<li>TO tenant( vserver BelongsTo tenant, MANY2ONE)</li>
+<li>TO flavor( vserver Uses flavor, MANY2ONE)</li>
+<li>TO image( vserver Uses image, MANY2ONE)</li>
+<li>TO pserver( vserver HostedOn pserver, MANY2ONE)</li>
+<li>TO snapshot( vserver Uses snapshot, ONE2ONE)</li>
+<li>TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)</li>
+<li>FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)</li>
+<li>FROM vce( vce HostedOn vserver, ONE2MANY)</li>
+<li>FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)</li>
+<li>FROM vf-module( vf-module Uses vserver, ONE2MANY)</li>
+<li>FROM vnfc( vnfc HostedOn vserver, ONE2MANY)</li>
+<p></p>
+<li>(1) IF this VSERVER node is deleted, this FROM node is DELETED also</li>
+<li>(2) IF this VSERVER node is deleted, this TO node is DELETED also</li></ul>
</section>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.</p>
<div class="json-inner-schema">
</div>
<span class="json-property-required"></span>
</dt>
<dd>
+ <p>Used to indicate whether closed loop function is enabled on this node</p>
<div class="json-inner-schema">
</div>
<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>
+<li>TO complex( zone LocatedIn complex, MANY2ONE)</li>
+<li>FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)</li>
+<li>FROM pnf( pnf LocatedIn zone, MANY2ONE)</li>
+<li>FROM pserver( pserver LocatedIn zone, MANY2ONE)</li>
+<li>FROM service-instance( service-instance LocatedIn zone, MANY2ONE)</li></ul>
</section>
Code Review / aai / aai-common.git / blobdiff