From f1a8fb1bc04f5d685f2b31d35db605f6fa054f60 Mon Sep 17 00:00:00 2001 From: "Kajur, Harish (vk250x)" Date: Sat, 24 Mar 2018 21:59:03 -0400 Subject: [PATCH] Add plugin to check coverage Get line coverage to 50% and ensure it doesn't go down Issue-ID: AAI-498 Change-Id: Ib466b7e2b7cb6d2f888e3b58c2073bb02ab6f809 Signed-off-by: Kajur, Harish (vk250x) --- aai-core/pom.xml | 30 +- .../java/org/onap/aai/introspection/Version.java | 37 +- .../main/java/org/onap/aai/util/GenerateXsd.java | 2038 +- .../onap/aai/util/genxsd/DeleteFootnoteSet.java | 57 + .../org/onap/aai/util/genxsd/DeleteOperation.java | 106 + .../org/onap/aai/util/genxsd/EdgeDescription.java | 242 + .../java/org/onap/aai/util/genxsd/EdgeRuleSet.java | 196 + .../org/onap/aai/util/genxsd/GetOperation.java | 121 + .../java/org/onap/aai/util/genxsd/HTMLfromOXM.java | 190 + .../org/onap/aai/util/genxsd/OxmFileProcessor.java | 199 + .../org/onap/aai/util/genxsd/PatchOperation.java | 116 + .../org/onap/aai/util/genxsd/PutOperation.java | 114 + .../onap/aai/util/genxsd/PutRelationPathSet.java | 216 + .../java/org/onap/aai/util/genxsd/XSDElement.java | 678 + .../java/org/onap/aai/util/genxsd/XSDJavaType.java | 64 + .../java/org/onap/aai/util/genxsd/YAMLfromOXM.java | 470 + .../src/test/java/org/onap/aai/AAIJunitRunner.java | 7 +- .../src/test/java/org/onap/aai/HttpTestUtil.java | 21 +- .../org/onap/aai/introspection/MoxyLoaderTest.java | 77 + .../onap/aai/introspection/PojoStrategyTest.java | 65 + .../org/onap/aai/introspection/VersionTest.java | 50 + .../introspection/generator/CreateExampleTest.java | 118 + .../aai/introspection/sideeffect/DataCopyTest.java | 36 +- .../aai/introspection/sideeffect/DataLinkTest.java | 49 +- .../aai/introspection/tools/DefaultFieldsTest.java | 79 + .../introspection/tools/InjectKeysFromURITest.java | 94 + .../tools/IntrospectorValidatorTest.java | 125 + .../tools/RemoveNonVisiblePropertyTest.java | 70 + .../onap/aai/parsers/query/GraphTraversalTest.java | 24 +- .../onap/aai/query/builder/ExcludeQueryTest.java | 130 + .../aai/query/builder/GremlinTraversalTest.java | 19 +- .../query/builder/QueryBuilderTestAbstraction.java | 94 +- .../onap/aai/query/builder/TraversalQueryTest.java | 78 +- .../java/org/onap/aai/rest/CloudRegionTest.java | 19 +- .../onap/aai/rest/GenericVnfLInterfaceTest.java | 24 +- .../java/org/onap/aai/rest/HPACapabilityTest.java | 21 +- .../test/java/org/onap/aai/rest/PserverTest.java | 20 +- .../test/java/org/onap/aai/rest/TenantTest.java | 23 +- .../java/org/onap/aai/rest/db/HttpEntryTest.java | 129 +- .../org/onap/aai/serialization/db/DbAliasTest.java | 16 +- .../aai/serialization/db/DbSerializerTest.java | 195 +- .../onap/aai/serialization/db/EdgeRulesTest.java | 18 - .../test/java/org/onap/aai/util/AAIConfigTest.java | 125 + .../org/onap/aai/util/AutoGenerateHtmlTest.java | 35 + .../java/org/onap/aai/util/GenerateXsdTest.java | 294 +- ...tyObfuscationConversionCommandLineUtilTest.java | 71 + .../onap/aai/util/StoreNotificationEventTest.java | 22 +- .../aai/util/genxsd/DeleteFootnoteSetTest.java | 83 + .../onap/aai/util/genxsd/DeleteOperationTest.java | 82 + .../onap/aai/util/genxsd/EdgeDescriptionTest.java | 392 + .../org/onap/aai/util/genxsd/EdgeRuleSetTest.java | 243 + .../org/onap/aai/util/genxsd/GetOperationTest.java | 107 + .../org/onap/aai/util/genxsd/HTMLfromOXMTest.java | 278 + .../onap/aai/util/genxsd/PatchOperationTest.java | 82 + .../org/onap/aai/util/genxsd/PutOperationTest.java | 84 + .../aai/util/genxsd/PutRelationPathSetTest.java | 223 + .../org/onap/aai/util/genxsd/XSDElementTest.java | 564 + .../org/onap/aai/util/genxsd/XSDJavaTypeTest.java | 101 + .../org/onap/aai/util/genxsd/YAMLfromOXMTest.java | 826 + .../aai_swagger_html/aai_swagger_v10.html | 68771 +++++++------------ .../aai_swagger_html/aai_swagger_v11.html | 50170 ++++---------- .../aai_swagger_html/aai_swagger_v12.html | 58196 +++++----------- .../aai_swagger_html/aai_swagger_v13.html | 58196 +++++----------- .../resources/aai_swagger_html/aai_swagger_v8.html | 50698 +++++--------- .../resources/aai_swagger_html/aai_swagger_v9.html | 64663 ++++++----------- .../aai_swagger_yaml/aai_swagger_v10.yaml | 15191 ++-- .../aai_swagger_yaml/aai_swagger_v11.yaml | 16406 ++--- .../aai_swagger_yaml/aai_swagger_v12.yaml | 16539 ++--- .../aai_swagger_yaml/aai_swagger_v13.yaml | 16539 ++--- .../resources/aai_swagger_yaml/aai_swagger_v8.yaml | 11895 +--- .../resources/aai_swagger_yaml/aai_swagger_v9.yaml | 13562 +--- aai-schema/src/main/resources/oxm/aai_oxm_v12.xml | 1 - aai-schema/src/main/resources/oxm/aai_oxm_v13.xml | 1 - 73 files changed, 144300 insertions(+), 306615 deletions(-) create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteFootnoteSet.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteOperation.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeDescription.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeRuleSet.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/GetOperation.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/HTMLfromOXM.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/OxmFileProcessor.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/PatchOperation.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/PutOperation.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/PutRelationPathSet.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/XSDElement.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/XSDJavaType.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/genxsd/YAMLfromOXM.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/MoxyLoaderTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/VersionTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/generator/CreateExampleTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/tools/DefaultFieldsTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/tools/InjectKeysFromURITest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/tools/IntrospectorValidatorTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/tools/RemoveNonVisiblePropertyTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/query/builder/ExcludeQueryTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/AAIConfigTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/AutoGenerateHtmlTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/JettyObfuscationConversionCommandLineUtilTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteFootnoteSetTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteOperationTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeDescriptionTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeRuleSetTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/GetOperationTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/HTMLfromOXMTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/PatchOperationTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/PutOperationTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/PutRelationPathSetTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/XSDElementTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/XSDJavaTypeTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/genxsd/YAMLfromOXMTest.java diff --git a/aai-core/pom.xml b/aai-core/pom.xml index 73f2a74d..de468af9 100644 --- a/aai-core/pom.xml +++ b/aai-core/pom.xml @@ -45,10 +45,11 @@ ${project.version} 4.5.1 2.2.3 - 1.0.0 - 1.2.3 - 2.3.21 - 5.15.3 + 1.0.0 + 1.2.3 + 2.3.21 + 5.15.3 + 0.50 @@ -282,6 +283,27 @@ ${project.reporting.outputDirectory}/jacoco + + default-check + + check + + + ${project.build.directory}/coverage-reports/jacoco.exec + + + BUNDLE + + + LINE + COVEREDRATIO + ${jacoco.line.coverage.limit} + + + + + + diff --git a/aai-core/src/main/java/org/onap/aai/introspection/Version.java b/aai-core/src/main/java/org/onap/aai/introspection/Version.java index 76ff939f..d32212b8 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/Version.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/Version.java @@ -19,6 +19,9 @@ */ package org.onap.aai.introspection; +/** + * Requires the order to be in ascending order + */ public enum Version { v8, v9, @@ -26,12 +29,38 @@ public enum Version { v11, v12, v13; - + + public static final String VERSION_EXPRESSION = "v8|v9|v10|v11|v12|v13|latest"; + public static final String VERSION_EXPRESSION_V8_PLUS = "v8|v9|v10|v11|v12|v13|latest"; + public static final String VERSION_EXPRESSION_V9_PLUS = "v9|v10|v11|v12|v13|latest"; + + /** + * Checks if v is the latest version + * @param v + * @return + */ public static boolean isLatest(Version v) { - return (Version.v13.equals(v)); //TODO update when we increment the version, or find a better way of doing this + return Version.getLatest().equals(v); } - + + /** + * Gets the latest version + * @return + */ public static Version getLatest(){ - return Version.v13; //TODO update when we increment the version, or find a better way of doing this + return Version.values()[Version.values().length-1]; + } + + /** + * To be used inplace of Version.getVersion(String) to correctly get version of "latest" + * @param v + * @return + */ + public static Version getVersion(String v) { + if ("latest".equals(v)) { + return Version.getLatest(); + } + return Version.valueOf(v); } + } diff --git a/aai-core/src/main/java/org/onap/aai/util/GenerateXsd.java b/aai-core/src/main/java/org/onap/aai/util/GenerateXsd.java index 4ee65dd0..63318da3 100644 --- a/aai-core/src/main/java/org/onap/aai/util/GenerateXsd.java +++ b/aai-core/src/main/java/org/onap/aai/util/GenerateXsd.java @@ -7,708 +7,71 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * + * + * http://www.apache.org/licenses/LICENSE-2.0 + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ============LICENSE_END========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. */ -package org.onap.aai.util; -import com.google.common.base.Joiner; -import com.jayway.jsonpath.JsonPath; -import org.apache.commons.lang3.StringUtils; -import org.apache.commons.text.similarity.LevenshteinDistance; +package org.onap.aai.util; import org.onap.aai.introspection.Version; -import org.onap.aai.serialization.db.EdgeProperty; -import org.w3c.dom.*; -import org.xml.sax.InputSource; +import org.onap.aai.util.genxsd.EdgeRuleSet; +import org.onap.aai.util.genxsd.HTMLfromOXM; +import org.onap.aai.util.genxsd.YAMLfromOXM; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; -import javax.xml.XMLConstants; -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.xpath.*; -import java.io.*; +import java.io.BufferedWriter; +import java.io.File; +import java.io.IOException; import java.nio.charset.Charset; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.util.*; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - public class GenerateXsd { private static final Logger logger = LoggerFactory.getLogger("GenerateXsd.class"); - - static String apiVersion = null; + protected static String apiVersion = null; static String apiVersionFmt = null; static boolean useAnnotationsInXsd = false; static String responsesUrl = null; static String responsesLabel = null; static String jsonEdges = null; + static EdgeRuleSet edgeRuleSet = null; static Map generatedJavaType; static Map appliedPaths; - static Map deletePaths; - static Map putRelationPaths; - static NodeList javaTypeNodes; - static Map javaTypeDefinitions = createJavaTypeDefinitions(); - private static Map createJavaTypeDefinitions() - { - StringBuffer aaiInternal = new StringBuffer(); - Map javaTypeDefinitions = new HashMap(); - aaiInternal.append(" aai-internal:\n"); - aaiInternal.append(" properties:\n"); - aaiInternal.append(" property-name:\n"); - aaiInternal.append(" type: string\n"); - aaiInternal.append(" property-value:\n"); - aaiInternal.append(" type: string\n"); - javaTypeDefinitions.put("aai-internal", aaiInternal.toString()); - return javaTypeDefinitions; - } public static final int VALUE_NONE = 0; public static final int VALUE_DESCRIPTION = 1; public static final int VALUE_INDEXED_PROPS = 2; + public static final int VALUE_CONTAINER = 3; private static final String generateTypeXSD = "xsd"; private static final String generateTypeYAML = "yaml"; private static final String root = "../aai-schema/src/main/resources"; + private static final String autoGenRoot = "aai-schema/src/main/resources"; + private static final String normalStartDir = "aai-core"; private static final String xsd_dir = root + "/aai_schema"; - private static final String yaml_dir = root + "/aai_swagger_yaml"; + private static final String yaml_dir = (((System.getProperty("user.dir") != null) && (!System.getProperty("user.dir").contains(normalStartDir))) ? autoGenRoot : root) + "/aai_swagger_yaml"; /* These three strings are for yaml auto-generation from aai-common class*/ - private static final String normalStartDir = "aai-core"; - private static final String autoGenRoot = "aai-schema/src/main/resources"; - private static final String alt_yaml_dir = autoGenRoot + "/aai_swagger_yaml"; +// private static final String alt_yaml_dir = autoGenRoot + "/aai_swagger_yaml"; private static int annotationsStartVersion = 9; // minimum version to support annotations in xsd private static int swaggerSupportStartsVersion = 7; // minimum version to support swagger documentation - private static XPath xpath = XPathFactory.newInstance().newXPath(); - - - private enum LineageType { - PARENT, CHILD, UNRELATED; - } - private class EdgeDescription { - - private String ruleKey; - private String to; - private String from; - private LineageType type = LineageType.UNRELATED; - private String direction; - private String multiplicity; - private String preventDelete; - private String deleteOtherV; - private boolean hasDelTarget = false; - private String label; - private String description; - /** - * @return the deleteOtherV - */ - public String getDeleteOtherV() { - return deleteOtherV; - } - /** - * @param deleteOtherV the deleteOtherV to set - */ - public void setDeleteOtherV(String deleteOtherV) { - logger.debug("Edge: "+this.getRuleKey()); - logger.debug("Truth: "+(("${direction}".equals(deleteOtherV)) ? "true" : "false")); - logger.debug("Truth: "+(("!${direction}".equals(deleteOtherV)) ? "true" : "false")); - - if("${direction}".equals(deleteOtherV) ) { - this.deleteOtherV = this.direction; - } else if("!${direction}".equals(deleteOtherV) ) { - this.deleteOtherV = this.direction.equals("IN") ? "OUT" : ((this.direction.equals("OUT")) ? "IN" : deleteOtherV); - } else { - this.deleteOtherV = deleteOtherV; - } - logger.debug("DeleteOtherV="+deleteOtherV+"/"+this.direction+"="+this.deleteOtherV); - } - /** - * @return the preventDelete - */ - public String getPreventDelete() { - return preventDelete; - } - /** - * @param preventDelete the preventDelete to set - */ - public void setPreventDelete(String preventDelete) { - if(this.getTo().equals("flavor") || this.getFrom().equals("flavor") ){ - logger.debug("Edge: "+this.getRuleKey()); - logger.debug("Truth: "+(("${direction}".equals(preventDelete)) ? "true" : "false")); - logger.debug("Truth: "+(("!${direction}".equals(preventDelete)) ? "true" : "false")); - } - - if("${direction}".equals(preventDelete) ) { - this.preventDelete = this.direction; - } else if("!${direction}".equals(preventDelete) ) { - this.preventDelete = this.direction.equals("IN") ? "OUT" : ((this.direction.equals("OUT")) ? "IN" : preventDelete); - } else { - this.preventDelete = preventDelete; - } - if(this.getTo().equals("flavor") || this.getFrom().equals("flavor")) { - logger.debug("PreventDelete="+preventDelete+"/"+this.direction+"="+this.preventDelete); - } - } - /** - * @return the to - */ - public String getTo() { - return to; - } - /** - * @param to the to to set - */ - public void setTo(String to) { - this.to = to; - } - /** - * @return the from - */ - public String getFrom() { - return from; - } - /** - * @param from the from to set - */ - public void setFrom(String from) { - this.from = from; - } - - - public String getRuleKey() { - return ruleKey; - } - public String getMultiplicity() { - return multiplicity; - } - public String getDirection() { - return direction; - } - public String getDescription() { - return this.description; - } - public void setRuleKey(String val) { - this.ruleKey=val; - } - public void setType(LineageType val) { - this.type=val; - } - public void setDirection(String val) { - this.direction = val; - } - public void setMultiplicity(String val) { - this.multiplicity=val; - } - public void setHasDelTarget(String val) { - hasDelTarget = Boolean.parseBoolean(val); - } - public void setDescription(String val) { - this.description = val; - } - - public String getRelationshipDescription(String fromTo, String otherNodeName) { - - String result = ""; - - if ("FROM".equals(fromTo)) { - if ("OUT".equals(direction)) { - if (LineageType.PARENT == type) { - result = " (PARENT of "+otherNodeName; - result = String.join(" ", result+",", this.from, this.getLabel(), this.to); - } - } - else { - if (LineageType.CHILD == type) { - result = " (CHILD of "+otherNodeName; - result = String.join(" ", result+",", this.from, this.getLabel(), this.to); - } - else if (LineageType.PARENT == type) { - result = " (PARENT of "+otherNodeName; - result = String.join(" ", result+",", this.from, this.getLabel(), this.to); - } - } - if (result.length() == 0) result = String.join(" ", "(", this.from, this.getLabel(), this.to+",", this.getMultiplicity()); - } else { - //if ("TO".equals(fromTo) - if ("OUT".equals(direction)) { - if (LineageType.PARENT == type) { - result = " (CHILD of "+otherNodeName; - result = String.join(" ", result+",", this.from, this.getLabel(), this.to+",", this.getMultiplicity()); - } - } else { - if (LineageType.PARENT == type) { - result = " (PARENT of "+otherNodeName; - result = String.join(" ", result+",", this.from, this.getLabel(), this.to+",", this.getMultiplicity()); - } - } - if (result.length() == 0) result = String.join(" ", "(", this.from, this.getLabel(), this.to+",", this.getMultiplicity()); - - } - - if (hasDelTarget) result = result + ", will delete target node"; - - if (result.length() > 0) result = result + ")"; - - if (description != null && description.length() > 0) result = result + "\n "+ description; // 6 spaces is important for yaml - - return result; - } - - /** - * @return the hasDelTarget - */ - @SuppressWarnings("unused") - public boolean isHasDelTarget() { - return hasDelTarget; - } - /** - * @param hasDelTarget the hasDelTarget to set - */ - @SuppressWarnings("unused") - public void setHasDelTarget(boolean hasDelTarget) { - this.hasDelTarget = hasDelTarget; - } - /** - * @return the type - */ - @SuppressWarnings("unused") - public LineageType getType() { - return type; - } - /** - * @return the label - */ - public String getLabel() { - return label; - } - public void setLabel(String string) { - this.label=string; - } - } - - private static class PutRelationPathSet { - String apiPath; - String opId; - ArrayList relations = new ArrayList(); - String objectName = ""; - String currentAPIVersion = ""; - public PutRelationPathSet(String opId, String path) { - super(); - this.apiPath = path.replace("/relationship-list/relationship", ""); - this.opId = opId; - objectName = GenerateXsd.deletePaths.get(apiPath); - currentAPIVersion = GenerateXsd.apiVersion; - } - public void process() { - this.toRelations(); - this.fromRelations(); - this.writeRelationsFile(); - - } - public void toRelations() { - logger.debug("{“comment”: “Valid TO Relations that can be added”},"); - logger.debug("apiPath: "+apiPath+"\nopId="+opId+"\nobjectName="+objectName); - Collection toEdges = GenerateXsd.getEdgeRulesTO(objectName); - - if(toEdges.size() > 0) { - relations.add("{\"comment\": \"Valid TO Relations that can be added\"}\n"); - } - for (EdgeDescription ed : toEdges) { - logger.debug(ed.getRuleKey()+"Type="+ed.type); - String obj = ed.getRuleKey().replace(objectName,"").replace("|",""); - String selectedRelation = ""; - if(ed.type == LineageType.UNRELATED) { - String selectObj = getUnrelatedObjectPaths(obj, apiPath); - logger.debug("SelectedObj:"+selectObj); - selectedRelation = formatObjectRelationSet(obj,selectObj); - logger.trace("ObjectRelationSet"+selectedRelation); - } else { - String selectObj = getKinObjectPath(obj, apiPath); - logger.debug("SelectedObj:"+selectObj); - selectedRelation = formatObjectRelation(obj,selectObj); - logger.trace("ObjectRelationSet"+selectedRelation); - } - relations.add(selectedRelation); - logger.trace(selectedRelation); - } - } - - public void fromRelations() { - logger.debug("“comment”: “Valid FROM Relations that can be added”"); - Collection fromEdges = getEdgeRulesFROM(objectName); - if(fromEdges.size() > 0) { - relations.add("{\"comment\": \"Valid FROM Relations that can be added\"}\n"); - } - for (EdgeDescription ed : fromEdges) { - logger.debug(ed.getRuleKey()+"Type="+ed.type); - String obj = ed.getRuleKey().replace(objectName,"").replace("|",""); - String selectedRelation = ""; - if(ed.type == LineageType.UNRELATED) { - String selectObj = getUnrelatedObjectPaths(obj, apiPath); - logger.debug("SelectedObj"+selectObj); - selectedRelation = formatObjectRelationSet(obj,selectObj); - logger.trace("ObjectRelationSet"+selectedRelation); - } else { - String selectObj = getKinObjectPath(obj, apiPath); - logger.debug("SelectedObj"+selectObj); - selectedRelation = formatObjectRelation(obj,selectObj); - logger.trace("ObjectRelationSet"+selectedRelation); - } - relations.add(selectedRelation); - logger.trace(selectedRelation); - } - } - public void writeRelationsFile() { - File examplefilePath = new File(yaml_dir + "/relations/" + currentAPIVersion+"/"+opId.replace("RelationshipListRelationship", "") + ".json"); - - logger.debug(String.join("exampleFilePath: ", examplefilePath.toString())); - FileOutputStream fop = null; - try { - if (!examplefilePath.exists()) { - examplefilePath.getParentFile().mkdirs(); - examplefilePath.createNewFile(); - } - fop = new FileOutputStream(examplefilePath); - } catch(Exception e) { - e.printStackTrace(); - return; - } - try { - if(relations.size() > 0) {fop.write("[\n".getBytes());} - fop.write(String.join(",\n", relations).getBytes()); - if(relations.size() > 0) {fop.write("\n]\n".getBytes());} - fop.flush(); - fop.close(); - } catch (Exception e) { - e.printStackTrace(); - return; - } - logger.debug(String.join(",\n", relations)); - return; - } - - private static String formatObjectRelationSet(String obj, String selectObj) { - StringBuffer pathSb = new StringBuffer(); - String[] paths = selectObj.split("[|]"); - for (String s: paths) { - logger.trace("SelectOBJ"+s); - pathSb.append(formatObjectRelation(obj, s)+",\n"); - } - pathSb.deleteCharAt(pathSb.length()-2); - return pathSb.toString(); - } - - private static String formatObjectRelation(String obj, String selectObj) { - StringBuffer pathSb = new StringBuffer(); - pathSb.append("{\n"); - pathSb.append("\"related-to\" : \""+obj+"\",\n"); - pathSb.append("\"related-link\" : \""+selectObj+"\"\n"); - pathSb.append("}"); - return pathSb.toString(); - } - - private static String getKinObjectPath(String obj, String apiPath) { - LevenshteinDistance proximity = new LevenshteinDistance(); - String targetPath = ""; - int targetScore = Integer.MAX_VALUE; - int targetMaxScore = 0; - for (Map.Entry p : deletePaths.entrySet()) { - if(p.getValue().equals(obj)) { - targetScore = (targetScore >= proximity.apply(apiPath, p.getKey())) ? proximity.apply(apiPath, p.getKey()) : targetScore; - targetPath = (targetScore >= proximity.apply(apiPath, p.getKey())) ? p.getKey() : targetPath; - targetMaxScore = (targetMaxScore <= proximity.apply(apiPath, p.getKey())) ? proximity.apply(apiPath, p.getKey()) : targetScore; - logger.trace(proximity.apply(apiPath, p.getKey())+":"+p.getKey()); - logger.trace(proximity.apply(apiPath, p.getKey())+":"+apiPath); - } - } - return targetPath; - } - - private static String getUnrelatedObjectPaths(String obj, String apiPath) { - String targetPath = ""; - logger.trace("Obj:"+obj +"\n" + apiPath); - for (Map.Entry p : deletePaths.entrySet()) { - if(p.getValue().equals(obj)) { - logger.trace("p.getvalue:"+p.getValue()+"p.getkey:"+p.getKey()); - targetPath += ((targetPath.length() == 0 ? "" : "|") + p.getKey()); - logger.trace("Match:"+apiPath +"\n" + targetPath); - } - } - return targetPath; - } - } - - private static class PatchOperation { - String useOpId; - String xmlRootElementName; - String tag; - String path; - String pathParams; - - public PatchOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { - super(); - this.useOpId = useOpId; - this.xmlRootElementName = xmlRootElementName; - this.tag = tag; - this.path = path; - this.pathParams = pathParams; - } - - @Override - public String toString() { - StringBuffer pathSb = new StringBuffer(); - pathSb.append(" patch:\n"); - pathSb.append(" tags:\n"); - pathSb.append(" - " + tag + "\n"); - - pathSb.append(" summary: update an existing " + xmlRootElementName + "\n"); - pathSb.append(" description: update an existing " + xmlRootElementName + "\n"); - pathSb.append(" operationId: Update" + useOpId + "\n"); - pathSb.append(" consumes:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" produces:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" responses:\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - - pathSb.append(" parameters:\n"); - pathSb.append(pathParams); // for nesting - pathSb.append(" - name: body\n"); - pathSb.append(" in: body\n"); - pathSb.append(" description: " + xmlRootElementName + " object that needs to be created or updated\n"); - pathSb.append(" required: true\n"); - pathSb.append(" schema:\n"); - pathSb.append(" $ref: \"patchSchema.yaml#/definitions/" + xmlRootElementName + "\"\n"); - - return pathSb.toString(); - } - public String toString1() { - StringBuffer pathSb = new StringBuffer(); - StringBuffer relationshipExamplesSb = new StringBuffer(); - if ( path.endsWith("/relationship") ) { - pathSb.append(" " + path + ":\n" ); - } - pathSb.append(" patch:\n"); - pathSb.append(" tags:\n"); - pathSb.append(" - " + tag + "\n"); - - if ( path.endsWith("/relationship") ) { - pathSb.append(" summary: see node definition for valid relationships\n"); - relationshipExamplesSb.append("[See Examples](apidocs/relations/"+GenerateXsd.apiVersion+"/"+useOpId+".json)"); - } else { - pathSb.append(" summary: update an existing " + xmlRootElementName + "\n"); - pathSb.append(" description: |\n"); - pathSb.append(" Update an existing " + xmlRootElementName + "\n"); - pathSb.append(" #\n"); - pathSb.append(" Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n"); - pathSb.append(" The PUT operation will entirely replace an existing object.\n"); - pathSb.append(" The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n"); - pathSb.append(" #\n"); - pathSb.append(" Other differences between PUT and PATCH are:\n"); - pathSb.append(" #\n"); - pathSb.append(" - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n"); - pathSb.append(" - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n"); - pathSb.append(" - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n"); - } - pathSb.append(" operationId: Update" + useOpId + "\n"); - pathSb.append(" consumes:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" produces:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" responses:\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - pathSb.append(" parameters:\n"); - pathSb.append(pathParams); // for nesting - pathSb.append(" - name: body\n"); - pathSb.append(" in: body\n"); - pathSb.append(" description: " + xmlRootElementName + " object that needs to be created or updated. "+relationshipExamplesSb.toString()+"\n"); - pathSb.append(" required: true\n"); - pathSb.append(" schema:\n"); - pathSb.append(" $ref: \"#/patchDefinitions/" + xmlRootElementName + "\"\n"); - return pathSb.toString(); - } - } - private static class PutOperation { - String useOpId; - String xmlRootElementName; - String tag; - String path; - String pathParams; - - public PutOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { - super(); - this.useOpId = useOpId; - this.xmlRootElementName = xmlRootElementName; - this.tag = tag; - this.path = path; - this.pathParams = pathParams; - } - - @Override - public String toString() { - StringBuffer pathSb = new StringBuffer(); - StringBuffer relationshipExamplesSb = new StringBuffer(); - if ( path.endsWith("/relationship") ) { - pathSb.append(" " + path + ":\n" ); - } - pathSb.append(" put:\n"); - pathSb.append(" tags:\n"); - pathSb.append(" - " + tag + "\n"); - - if ( path.endsWith("/relationship") ) { - pathSb.append(" summary: see node definition for valid relationships\n"); - } else { - pathSb.append(" summary: create or update an existing " + xmlRootElementName + "\n"); - pathSb.append(" description: |\n Create or update an existing " + xmlRootElementName + ".\n #\n Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n"); - } - relationshipExamplesSb.append("[Valid relationship examples shown here](apidocs/relations/"+GenerateXsd.apiVersion+"/"+useOpId.replace("RelationshipListRelationship", "")+".json)"); - pathSb.append(" operationId: createOrUpdate" + useOpId + "\n"); - pathSb.append(" consumes:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" produces:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" responses:\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - - pathSb.append(" parameters:\n"); - pathSb.append(pathParams); // for nesting - pathSb.append(" - name: body\n"); - pathSb.append(" in: body\n"); - pathSb.append(" description: " + xmlRootElementName + " object that needs to be created or updated. "+relationshipExamplesSb.toString()+"\n"); - pathSb.append(" required: true\n"); - pathSb.append(" schema:\n"); - pathSb.append(" $ref: \"#/definitions/" + xmlRootElementName + "\"\n"); - return pathSb.toString(); - } - public String tagRelationshipPathMapEntry() { - if ( path.endsWith("/relationship") ) { - putRelationPaths.put(useOpId, path); - } - return ""; - } - - } - - private static class GetOperation { - String useOpId; - String xmlRootElementName; - String tag; - String path; - @SuppressWarnings("unused") - String pathParams; - public GetOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { - super(); - this.useOpId = useOpId; - this.xmlRootElementName = xmlRootElementName; - this.tag = tag; - this.path = path; - this.pathParams = pathParams; - } - @Override - public String toString() { - StringBuffer pathSb = new StringBuffer(); - pathSb.append(" " + path + ":\n" ); - pathSb.append(" get:\n"); - pathSb.append(" tags:\n"); - pathSb.append(" - " + tag + "\n"); - pathSb.append(" summary: returns " + xmlRootElementName + "\n"); - - pathSb.append(" description: returns " + xmlRootElementName + "\n"); - pathSb.append(" operationId: get" + useOpId + "\n"); - pathSb.append(" produces:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - - pathSb.append(" responses:\n"); - pathSb.append(" \"200\":\n"); - pathSb.append(" description: successful operation\n"); - pathSb.append(" schema:\n"); - pathSb.append(" $ref: \"#/getDefinitions/" + xmlRootElementName + "\"\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - - return pathSb.toString(); - } - - } - private static class DeleteOperation { - String useOpId; - String xmlRootElementName; - String tag; - String path; - String pathParams; - public DeleteOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { - super(); - this.useOpId = useOpId; - this.xmlRootElementName = xmlRootElementName; - this.tag = tag; - this.path = path; - this.pathParams = pathParams; - } - @Override - public String toString() { - StringBuffer pathSb = new StringBuffer(); - pathSb.append(" delete:\n"); - pathSb.append(" tags:\n"); - pathSb.append(" - " + tag + "\n"); - pathSb.append(" summary: delete an existing " + xmlRootElementName + "\n"); - - pathSb.append(" description: delete an existing " + xmlRootElementName + "\n"); - - pathSb.append(" operationId: delete" + useOpId + "\n"); - pathSb.append(" consumes:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" produces:\n"); - pathSb.append(" - application/json\n"); - pathSb.append(" - application/xml\n"); - pathSb.append(" responses:\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - pathSb.append(" parameters:\n"); - - pathSb.append(pathParams); // for nesting - if ( !path.endsWith("/relationship") ) { - pathSb.append(" - name: resource-version\n"); - - pathSb.append(" in: query\n"); - pathSb.append(" description: resource-version for concurrency\n"); - pathSb.append(" required: true\n"); - pathSb.append(" type: string\n"); - } - return pathSb.toString(); - } - public String objectPathMapEntry() { - if (! path.endsWith("/relationship") ) { - deletePaths.put(path, xmlRootElementName); - } - return (xmlRootElementName+":"+path); - } - - } - private static boolean validVersion(String versionToGen) { if ("ALL".equalsIgnoreCase(versionToGen)) { @@ -738,6 +101,18 @@ public class GenerateXsd { return false; } + public static String getAPIVersion() { + return apiVersion; + } + + public static String getYamlDir() { + return yaml_dir; + } + + public static String getResponsesUrl() { + return responsesUrl; + } + public static void main(String[] args) throws IOException { String versionToGen = System.getProperty("gen_version").toLowerCase(); String fileTypeToGen = System.getProperty("gen_type").toLowerCase(); @@ -768,7 +143,7 @@ public class GenerateXsd { Collections.sort(versionsToGen); Collections.reverse(versionsToGen); } else { - versionsToGen.add(Version.valueOf(versionToGen)); + versionsToGen.add(Version.getVersion(versionToGen)); } //process file type System property @@ -795,31 +170,46 @@ public class GenerateXsd { String outfileName; File outfile; - String fileContent; + String fileContent = null; for (Version v : versionsToGen) { apiVersion = v.toString(); - logger.info("Generating " + apiVersion + " " + fileTypeToGen); + logger.debug("YAMLdir = "+yaml_dir); + logger.debug("Generating " + apiVersion + " " + fileTypeToGen); File oxm_file = new File(oxmPath + "aai_oxm_" + apiVersion + ".xml"); apiVersionFmt = "." + apiVersion + "."; generatedJavaType = new HashMap(); appliedPaths = new HashMap(); - putRelationPaths = new HashMap(); - deletePaths = new HashMap(); - + File edgeRuleFile = null; + logger.debug("user.dir = "+System.getProperty("user.dir")); + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(normalStartDir)) { + edgeRuleFile = new File(normalStartDir + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + } + else { + edgeRuleFile = new File("src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + } + if ( fileTypeToGen.equals(generateTypeXSD) ) { useAnnotationsInXsd = versionUsesAnnotations(apiVersion); outfileName = xsd_dir + "/aai_schema_" + apiVersion + "." + generateTypeXSD; - fileContent = processOxmFile(oxm_file, v, null); - } else if ( versionSupportsSwagger(apiVersion )) { - if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(normalStartDir)) { - outfileName = alt_yaml_dir; + try { + HTMLfromOXM swagger = new HTMLfromOXM(oxm_file, v); + fileContent = swagger.process(); + } catch(Exception e) { + logger.error( "Exception creating output file " + outfileName); + logger.error( e.getMessage()); + e.printStackTrace(); } - else { - outfileName = yaml_dir; + } else if ( versionSupportsSwagger(apiVersion )) { + outfileName = yaml_dir + "/aai_swagger_" + apiVersion + "." + generateTypeYAML; + try { + YAMLfromOXM swagger = new YAMLfromOXM(oxm_file, v, edgeRuleFile); + fileContent = swagger.process(); + } catch(Exception e) { + logger.error( "Exception creating output file " + outfileName); + logger.error( e.getMessage()); + e.printStackTrace(); } - outfileName = outfileName + "/aai_swagger_" + apiVersion + "." + generateTypeYAML; - fileContent = generateSwaggerFromOxmFile( oxm_file, null); } else { continue; } @@ -848,1310 +238,8 @@ public class GenerateXsd { bw.close(); } } - logger.info( "GeneratedXSD successful, saved in " + outfileName); - } - - } - - - public static String processJavaTypeElement( String javaTypeName, Element javaTypeElement) { - - String xmlRootElementName = null; - - NodeList parentNodes = javaTypeElement.getElementsByTagName("java-attributes"); - StringBuffer sb = new StringBuffer(); - if ( parentNodes.getLength() == 0 ) { - logger.trace( "no java-attributes for java-type " + javaTypeName); - return ""; - - } - - NamedNodeMap attributes; - - NodeList valNodes = javaTypeElement.getElementsByTagName("xml-root-element"); - Element valElement = (Element) valNodes.item(0); - attributes = valElement.getAttributes(); - for ( int i = 0; i < attributes.getLength(); ++i ) { - Attr attr = (Attr) attributes.item(i); - String attrName = attr.getNodeName(); - - String attrValue = attr.getNodeValue(); - logger.trace("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); - if ( attrName.equals("name")) - xmlRootElementName = attrValue; - } - - Element parentElement = (Element)parentNodes.item(0); - NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); - NodeList childNodes; - Element childElement; - String xmlElementWrapper; - - Element xmlElementElement; - String addType; - String elementName, elementType, elementIsKey, elementIsRequired, elementContainerType; - StringBuffer sb1 = new StringBuffer(); - if ( xmlElementNodes.getLength() > 0 ) { - sb1.append(" \n"); - sb1.append(" \n"); - NodeList properties = GenerateXsd.locateXmlProperties(javaTypeElement); - if (properties != null && useAnnotationsInXsd) { - logger.trace("properties found for: " + xmlRootElementName); - sb1.append(" \r\n"); - insertAnnotation(properties, false, "class", sb1, " "); - - sb1.append(" \r\n"); - } else { - logger.trace("no properties found for: " + xmlRootElementName); - } - sb1.append(" \n"); - for ( int i = 0; i < xmlElementNodes.getLength(); ++i ) { - - xmlElementElement = (Element)xmlElementNodes.item(i); - childNodes = xmlElementElement.getElementsByTagName("xml-element-wrapper"); - - xmlElementWrapper = null; - if ( childNodes.getLength() > 0 ) { - childElement = (Element)childNodes.item(0); - // get name - attributes = childElement.getAttributes(); - for ( int k = 0; k < attributes.getLength(); ++k ) { - Attr attr = (Attr) attributes.item(k); - String attrName = attr.getNodeName(); - String attrValue = attr.getNodeValue(); - if ( attrName.equals("name")) { - xmlElementWrapper = attrValue; - logger.trace("found xml-element-wrapper " + xmlElementWrapper); - } - } - - } - attributes = xmlElementElement.getAttributes(); - addType = null; - - - elementName = elementType = elementIsKey = elementIsRequired = elementContainerType = null; - for ( int j = 0; j < attributes.getLength(); ++j ) { - Attr attr = (Attr) attributes.item(j); - String attrName = attr.getNodeName(); - - String attrValue = attr.getNodeValue(); - logger.trace("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); - if ( attrName.equals("name")) { - elementName = attrValue; - } - if ( attrName.equals("type")) { - elementType = attrValue; - if ( attrValue.contains(apiVersionFmt) ) { - addType = attrValue.substring(attrValue.lastIndexOf('.')+1); - if ( !generatedJavaType.containsKey(addType) ) { - generatedJavaType.put(addType, attrValue); - sb.append(processJavaTypeElement( addType, getJavaTypeElement(addType) )); - } - } - - } - - if ( attrName.equals("xml-key")) { - elementIsKey = attrValue; - } - if ( attrName.equals("required")) { - elementIsRequired = attrValue; - } - if ( attrName.equals("container-type")) { - elementContainerType = attrValue; - } - } - - if ( xmlElementWrapper != null ) { - sb1.append(" \n"); - sb1.append(" \n"); - properties = GenerateXsd.locateXmlProperties(javaTypeElement); - if (properties != null && useAnnotationsInXsd) { - sb1.append(" \r\n"); - insertAnnotation(properties, false, "class", sb1, " "); - sb1.append(" \r\n"); - } else { - logger.trace("no properties found for: " + xmlElementWrapper); - } - sb1.append(" \n"); - sb1.append(" "); - } - if ("Nodes".equals(addType)) { - logger.trace("Skipping nodes, temporary testing"); - continue; - } - if ( addType != null ) { - sb1.append(" \n"); - if ( useAnnotationsInXsd ) { - sb1.append(" \r\n"); - insertAnnotation(properties, elementIsKey != null, "field", sb1, " "); - sb1.append(" \r\n"); - } - if (xmlElementWrapper== null) { - sb1.append(" \n"); - } - } else { - sb1.append("/>\n"); - } - if ( xmlElementWrapper != null ) { - sb1.append(" \n"); - sb1.append(" \n"); - sb1.append(" \n"); - } - } - sb1.append(" \n"); - sb1.append(" \n"); - sb1.append(" \n"); - } - - if ( xmlElementNodes.getLength() < 1 ) { - sb.append(" \n"); - sb.append(" \n"); - sb.append(" \n"); - sb.append(" \n"); - sb.append(" \n"); - generatedJavaType.put(javaTypeName, null); - return sb.toString(); - } - sb.append( sb1 ); - return sb.toString(); - } - - private static void insertAnnotation(NodeList items, boolean isKey, String target, StringBuffer sb1, String indentation) { - if (items != null || isKey) { - List metadata = new ArrayList<>(); - - String name = ""; - String value = ""; - Element item = null; - if (isKey) { - metadata.add("isKey=true"); - } - if (items != null) { - for (int i = 0; i < items.getLength(); i++) { - item = (Element)items.item(i); - name = item.getAttribute("name"); - value = item.getAttribute("value"); - if (name.equals("abstract")) { - name = "isAbstract"; - } else if (name.equals("extends")) { - name = "extendsFrom"; - } - metadata.add(name + "=\"" + value.replaceAll("&", "&") + "\""); - } - } - sb1.append( - indentation + " \r\n" + - indentation + " @org.onap.aai.annotations.Metadata(" + Joiner.on(",").join(metadata) + ")\r\n" + - indentation + " \r\n"); - } - - } - - private static Element getJavaTypeElement( String javaTypeName ) - { - - String attrName, attrValue; - Attr attr; - Element javaTypeElement; - for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { - javaTypeElement = (Element) javaTypeNodes.item(i); - NamedNodeMap attributes = javaTypeElement.getAttributes(); - for ( int j = 0; j < attributes.getLength(); ++j ) { - attr = (Attr) attributes.item(j); - attrName = attr.getNodeName(); - attrValue = attr.getNodeValue(); - if ( attrName.equals("name") && attrValue.equals(javaTypeName)) - return javaTypeElement; - } - } - logger.error( "oxm file format error, missing java-type " + javaTypeName); - return (Element) null; - } - - private static Element getJavaTypeElementSwagger( String javaTypeName ) - { - - String attrName, attrValue; - Attr attr; - Element javaTypeElement; - for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { - javaTypeElement = (Element) javaTypeNodes.item(i); - NamedNodeMap attributes = javaTypeElement.getAttributes(); - for ( int j = 0; j < attributes.getLength(); ++j ) { - attr = (Attr) attributes.item(j); - attrName = attr.getNodeName(); - attrValue = attr.getNodeValue(); - if ( attrName.equals("name") && attrValue.equals(javaTypeName)) - return javaTypeElement; - } - } - logger.error( "oxm file format error, missing java-type " + javaTypeName); - return (Element) null; - } - private static String getXmlRootElementName( String javaTypeName ) - { - - String attrName, attrValue; - Attr attr; - Element javaTypeElement; - for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { - javaTypeElement = (Element) javaTypeNodes.item(i); - NamedNodeMap attributes = javaTypeElement.getAttributes(); - for ( int j = 0; j < attributes.getLength(); ++j ) { - attr = (Attr) attributes.item(j); - attrName = attr.getNodeName(); - attrValue = attr.getNodeValue(); - if ( attrName.equals("name") && attrValue.equals(javaTypeName)) { - NodeList valNodes = javaTypeElement.getElementsByTagName("xml-root-element"); - Element valElement = (Element) valNodes.item(0); - attributes = valElement.getAttributes(); - for ( int k = 0; k < attributes.getLength(); ++k ) { - attr = (Attr) attributes.item(k); - attrName = attr.getNodeName(); - - attrValue = attr.getNodeValue(); - if ( attrName.equals("name")) - return (attrValue); - } - } - } - } - logger.error( "oxm file format error, missing java-type " + javaTypeName); - return null; - } - - - public static String processOxmFile( File oxmFile, Version v, String xml ) - { - if ( xml != null ){ - apiVersion = v.toString(); - useAnnotationsInXsd = true; - apiVersionFmt = "." + apiVersion + "."; - generatedJavaType = new HashMap<>(); - appliedPaths = new HashMap<>(); - } - StringBuilder sb = new StringBuilder(); - logger.trace("processing starts"); - sb.append("\n"); - String namespace = "org.onap"; - if (v.compareTo(Version.v11) < 0) { - namespace = "org.openecomp"; - } - if ( useAnnotationsInXsd ) { - sb.append("\n\n"); - } else { - - sb.append("\n\n"); - } - - try { - - DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); - dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); - DocumentBuilder dBuilder = dbFactory.newDocumentBuilder(); - Document doc; - - if ( xml == null ){ - doc = dBuilder.parse(oxmFile); - } else { - InputSource is = new InputSource(new StringReader(xml)); - doc = dBuilder.parse(is); - } - NodeList bindingsNodes = doc.getElementsByTagName("xml-bindings"); - Element bindingElement; - NodeList javaTypesNodes; - Element javaTypesElement; - - Element javaTypeElement; - - - if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - - bindingElement = (Element) bindingsNodes.item(0); - javaTypesNodes = bindingElement.getElementsByTagName("java-types"); - if ( javaTypesNodes.getLength() < 1 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - javaTypesElement = (Element) javaTypesNodes.item(0); - javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); - if ( javaTypeNodes.getLength() < 1 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - - String javaTypeName; - String attrName, attrValue; - Attr attr; - for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { - javaTypeElement = (Element) javaTypeNodes.item(i); - NamedNodeMap attributes = javaTypeElement.getAttributes(); - javaTypeName = null; - for ( int j = 0; j < attributes.getLength(); ++j ) { - attr = (Attr) attributes.item(j); - attrName = attr.getNodeName(); - attrValue = attr.getNodeValue(); - if ( attrName.equals("name")) - javaTypeName = attrValue; - } - if ( javaTypeName == null ) { - logger.error( " has no name attribute in " + oxmFile ); - return null; - } - if ("Nodes".equals(javaTypeName)) { - logger.debug("skipping Nodes entry (temporary feature)"); - continue; - } - if ( !generatedJavaType.containsKey(javaTypeName) ) { - generatedJavaType.put(javaTypeName, null); - sb.append(processJavaTypeElement( javaTypeName, javaTypeElement )); - } - } - - } catch (Exception e) { - e.printStackTrace(); - return null; - } - sb.append("\n"); - return sb.toString(); - } - - public static String toDeleteRules(String objectName) { - Collection toEdges = GenerateXsd.getEdgeRulesTO(objectName); - logger.debug("TO Edges count: "+toEdges.size()+" Object: "+objectName); - String prevent=null; - String also=null; - LinkedHashSet preventDelete = new LinkedHashSet(); - LinkedHashSet alsoDelete = new LinkedHashSet(); - for (EdgeDescription ed : toEdges) { - logger.debug("{“comment”: From = "+ed.getFrom()+" To: "+ed.getTo()+" Object: "+objectName); - logger.debug("{“comment”: Direction = "+ed.getDirection()+" PreventDelete: "+ed.getPreventDelete()+" DeleteOtherV: "+ed.getDeleteOtherV()+" Object: "+objectName); - if(ed.getPreventDelete().equals("IN") && ed.getTo().equals(objectName)) { - preventDelete.add(ed.getFrom().toUpperCase()); - } - if(ed.getDeleteOtherV().equals("IN") && ed.getTo().equals(objectName) ) { - alsoDelete.add(ed.getFrom().toUpperCase()); - } - } - if(preventDelete.size() > 0) { - prevent = " - "+objectName.toUpperCase()+" cannot be deleted if linked to "+String.join(",",preventDelete); - logger.info(prevent); - } - if(alsoDelete.size() > 0) { - also = " - "+objectName.toUpperCase()+" is DELETED when these are DELETED "+String.join(",",alsoDelete); - // This commented out line is better (gets who deletes what correct) but still not accurate. - //also = " - Deletion of an instance of "+objectName.toUpperCase()+" causes instances of these directly related types to be DELETED ["+String.join(",",alsoDelete)+"]"; - logger.info(also); - } - return String.join((prevent == null || also == null) ? "" : "\n", prevent == null ? "" : prevent, also == null ? "" : also)+((prevent == null && also == null) ? "" : "\n"); - } - - public static String fromDeleteRules(String objectName) { - Collection fromEdges = GenerateXsd.getEdgeRulesFROM(objectName); - LinkedHashSet preventDelete = new LinkedHashSet (); - LinkedHashSet alsoDelete = new LinkedHashSet (); - String prevent=null; - String also=null; - for (EdgeDescription ed : fromEdges) { - logger.debug("{“comment”: From = "+ed.getFrom()+" To: "+ed.getTo()+" Object: "+objectName); - logger.debug("{“comment”: Direction = "+ed.getDirection()+" PreventDelete: "+ed.getPreventDelete()+" DeleteOtherV: "+ed.getDeleteOtherV()+" Object: "+objectName); - if(ed.getPreventDelete().equals("OUT") && ed.getFrom().equals(objectName)) { - preventDelete.add(ed.getTo().toUpperCase()); - } - if(ed.getDeleteOtherV().equals("OUT") && ed.getFrom().equals(objectName) ) { - alsoDelete.add(ed.getTo().toUpperCase()); - } - } - if(preventDelete.size() > 0) { - prevent = " - "+objectName.toUpperCase()+" cannot be deleted if linked to "+String.join(",",preventDelete); - logger.info(prevent); - } - if(alsoDelete.size() > 0) { - also = " - "+objectName.toUpperCase()+" deletion means associated objects of these types are also DELETED:"+String.join(",",alsoDelete); - // This commented out line is better (gets who deletes what correct) but still not accurate. - //also = " - Deletion of an instance of "+objectName.toUpperCase()+" causes instances of these directly related types to be DELETED ["+String.join(",",alsoDelete)+"]"; - logger.info(also); - } - return String.join((prevent == null || also == null) ? "" : "\n", prevent == null ? "" : prevent, also == null ? "" : also)+((prevent == null && also == null) ? "" : "\n"); - } - - - private static boolean isStandardType( String elementType ) - { - switch ( elementType ) { - case "java.lang.String": - case "java.lang.Long": - case "java.lang.Integer": - case"java.lang.Boolean": - return true; - } - return false; - } - - private static Vector getIndexedProps( String attrValue ) - { - if ( attrValue == null ) - return null; - StringTokenizer st = new StringTokenizer( attrValue, ","); - if ( st.countTokens() == 0 ) - return null; - Vector result = new Vector(); - while ( st.hasMoreTokens()) { - result.add(st.nextToken()); - } - return result; - } - - /** - * Guaranteed to at least return non null but empty collection of edge descriptions - * @param nodeName name of the vertex whose edge relationships to return - * @return collection of node neighbors based on DbEdgeRules - **/ - private static Collection getEdgeRulesFromJson( String path, boolean skipMatch ) - { - - ArrayList result = new ArrayList<>(); - Iterator> edgeRulesIterator; - try { - - GenerateXsd x = new GenerateXsd(); - - List> inEdges = JsonPath.parse(jsonEdges).read(path); - - edgeRulesIterator = inEdges.iterator(); - Map edgeMap; - String fromNode; - String toNode; - String direction; - String multiplicity; - String isParent; - String hasDelTarget; - String deleteOtherV; - String preventDelete; - String description; - EdgeDescription edgeDes; - - while( edgeRulesIterator.hasNext() ){ - edgeMap = edgeRulesIterator.next(); - fromNode = (String)edgeMap.get("from"); - toNode = (String)edgeMap.get("to"); - if ( skipMatch ) { - if ( fromNode.equals(toNode)) { - continue; - } - } - edgeDes = x.new EdgeDescription(); - edgeDes.setRuleKey(fromNode + "|" + toNode); - edgeDes.setLabel((String)edgeMap.get("label")); - edgeDes.setTo((String)edgeMap.get("to")); - edgeDes.setFrom((String)edgeMap.get("from")); - direction = (String)edgeMap.get("direction"); - edgeDes.setDirection(direction); - multiplicity = (String)edgeMap.get("multiplicity"); - edgeDes.setMultiplicity(multiplicity); - isParent = (String)edgeMap.get(EdgeProperty.CONTAINS.toString()); - if ( "${direction}".equals(isParent)) { - edgeDes.setType(LineageType.PARENT); - } else { - edgeDes.setType(LineageType.UNRELATED); - } - hasDelTarget = (String)edgeMap.get(EdgeProperty.DELETE_OTHER_V.toString()); - deleteOtherV = (String)edgeMap.get(EdgeProperty.DELETE_OTHER_V.toString()); - edgeDes.setDeleteOtherV(deleteOtherV); - edgeDes.setHasDelTarget(hasDelTarget); - preventDelete = (String)edgeMap.get(EdgeProperty.PREVENT_DELETE.toString()); - edgeDes.setPreventDelete(preventDelete); - description = (String)edgeMap.get(EdgeProperty.DESCRIPTION.toString()); - edgeDes.setDescription(description); - - result.add(edgeDes); - logger.debug("Edge: "+edgeDes.getRuleKey()); - } - } catch (Exception ex) { - ex.printStackTrace(); - } - return result; - - } - - /** - * Guaranteed to at least return non null but empty collection of edge descriptions - * @param nodeName name of the vertex whose edge relationships to return - * @return collection of node neighbors based on DbEdgeRules - **/ - private static Collection getEdgeRules( String nodeName ) - { - String fromRulesPath = "$['rules'][?(@['from']=='" + nodeName + "')]"; - String toRulesPath = "$['rules'][?(@['to']=='" + nodeName + "')]"; - Collection fromEdges = getEdgeRulesFromJson( fromRulesPath, false ); - Collection edges = getEdgeRulesFromJson( toRulesPath, true ); - edges.addAll(fromEdges); - return edges; - } - - private static Collection getEdgeRulesTO( String nodeName ) - { - String toRulesPath = "$['rules'][?(@['to']=='" + nodeName + "')]"; - Collection edges = getEdgeRulesFromJson( toRulesPath, true ); - return edges; - } - - private static Collection getEdgeRulesFROM( String nodeName ) - { - String fromRulesPath = "$['rules'][?(@['from']=='" + nodeName + "')]"; - Collection edges = getEdgeRulesFromJson( fromRulesPath, true ); - return edges; - } - public static String processJavaTypeElementSwagger( String javaTypeName, Element javaTypeElement, - StringBuffer pathSb, StringBuffer definitionsSb, String path, String tag, String opId, - String getItemName, StringBuffer pathParams, String queryParams, String validEdges) { - - String xmlRootElementName = null; - StringBuilder definitionsLocalSb = new StringBuilder(256); - - String useTag = null; - String useOpId = null; - - if ( tag != null ) { - switch ( tag ) { - case "Network": - case "ServiceDesignAndCreation": - case "Business": - case "LicenseManagement": - case "CloudInfrastructure": - break; - default: - return null; - } - } - - if ( !javaTypeName.equals("Inventory") ) { - if ( javaTypeName.equals("AaiInternal")) - return null; - if ( opId == null ) - useOpId = javaTypeName; - else - useOpId = opId + javaTypeName; - if ( tag == null ) - useTag = javaTypeName; - } - - NodeList parentNodes = javaTypeElement.getElementsByTagName("java-attributes"); - - if ( parentNodes.getLength() == 0 ) { - logger.trace( "no java-attributes for java-type " + javaTypeName); - return ""; - } - - NamedNodeMap attributes; - - NodeList valNodes = javaTypeElement.getElementsByTagName("xml-root-element"); - Element valElement = (Element) valNodes.item(0); - attributes = valElement.getAttributes(); - for ( int i = 0; i < attributes.getLength(); ++i ) { - Attr attr = (Attr) attributes.item(i); - String attrName = attr.getNodeName(); - - String attrValue = attr.getNodeValue(); - logger.trace("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); - if ( attrName.equals("name")) - xmlRootElementName = attrValue; - } - - NodeList childNodes; - Element childElement; - NodeList xmlPropNodes = javaTypeElement.getElementsByTagName("xml-properties"); - Element xmlPropElement; - String pathDescriptionProperty = null; - - - Vector indexedProps = null; - - if ( xmlPropNodes.getLength() > 0 ) { - - for ( int i = 0; i < xmlPropNodes.getLength(); ++i ) { - xmlPropElement = (Element)xmlPropNodes.item(i); - if ( !xmlPropElement.getParentNode().isSameNode(javaTypeElement)) - continue; - childNodes = xmlPropElement.getElementsByTagName("xml-property"); - - if ( childNodes.getLength() > 0 ) { - for ( int j = 0; j < childNodes.getLength(); ++j ) { - childElement = (Element)childNodes.item(j); - // get name - int useValue = VALUE_NONE; - attributes = childElement.getAttributes(); - for ( int k = 0; k < attributes.getLength(); ++k ) { - Attr attr = (Attr) attributes.item(k); - String attrName = attr.getNodeName(); - String attrValue = attr.getNodeValue(); - if ( attrName == null || attrValue == null ) - continue; - if ( attrName.equals("name") && attrValue.equals("description")) { - useValue = VALUE_DESCRIPTION; - } - if ( useValue == VALUE_DESCRIPTION && attrName.equals("value")) { - pathDescriptionProperty = attrValue; - } - if ( attrValue.equals("indexedProps")) { - useValue = VALUE_INDEXED_PROPS; - } - if ( useValue == VALUE_INDEXED_PROPS && attrName.equals("value")) { - indexedProps = getIndexedProps( attrValue ); - } - } - } - } - } - } - logger.trace("javaTypeName " + javaTypeName + " description " + pathDescriptionProperty); - - Element parentElement = (Element)parentNodes.item(0); - NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); - - - String attrDescription = null; - - Element xmlElementElement; - String addType = null; - String elementType = null, elementIsKey = null, elementIsRequired, elementContainerType = null; - String elementName = null; - StringBuffer sbParameters = new StringBuffer(); - - StringBuffer sbRequired = new StringBuffer(); - int requiredCnt = 0; - int propertyCnt = 0; - StringBuffer sbProperties = new StringBuffer(); - StringBuffer sbIndexedParams = new StringBuffer(); - - - StringTokenizer st; - if ( xmlRootElementName.equals("inventory")) - path = ""; - else if ( path == null ) - path = "/" + xmlRootElementName; - else - path += "/" + xmlRootElementName; - st = new StringTokenizer(path, "/"); - boolean genPath = false; - - if ( st.countTokens() > 1 && getItemName == null ) { - if ( appliedPaths.containsKey(path)) - return null; - appliedPaths.put(path, xmlRootElementName); - genPath = true; - if ( path.contains("/relationship/") ) { // filter paths with relationship-list - genPath = false; - } - if ( path.endsWith("/relationship-list")) { - genPath = false; - } - - } - - Vector addTypeV = null; - if ( xmlElementNodes.getLength() > 0 ) { - - for ( int i = 0; i < xmlElementNodes.getLength(); ++i ) { - xmlElementElement = (Element)xmlElementNodes.item(i); - if ( !xmlElementElement.getParentNode().isSameNode(parentElement)) - continue; - - valNodes = xmlElementElement.getElementsByTagName("xml-properties"); - attrDescription = null; - if ( valNodes.getLength() > 0 ) { - for ( int j = 0; j < valNodes.getLength(); ++j ) { - valElement = (Element)valNodes.item(j); - if ( !valElement.getParentNode().isSameNode(xmlElementElement)) - continue; - childNodes = valElement.getElementsByTagName("xml-property"); - if ( childNodes.getLength() > 0 ) { - childElement = (Element)childNodes.item(0); - // get name - attributes = childElement.getAttributes(); - attrDescription = null; - boolean useValue = false; - for ( int k = 0; k < attributes.getLength(); ++k ) { - Attr attr = (Attr) attributes.item(k); - String attrName = attr.getNodeName(); - String attrValue = attr.getNodeValue(); - if ( attrName.equals("name") && attrValue.equals("description")) { - useValue = true; - } - if ( useValue && attrName.equals("value")) { - attrDescription = attrValue; - } - } - - } - } - } - - attributes = xmlElementElement.getAttributes(); - addTypeV = null; // vector of 1 - addType = null; - - elementName = elementType = elementIsKey = elementIsRequired = elementContainerType = null; - for ( int j = 0; j < attributes.getLength(); ++j ) { - Attr attr = (Attr) attributes.item(j); - String attrName = attr.getNodeName(); - - String attrValue = attr.getNodeValue(); - logger.trace("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); - if ( attrName.equals("name")) { - elementName = attrValue; - - } - if ( attrName.equals("type") && getItemName == null ) { - elementType = attrValue; - if ( attrValue.contains(apiVersionFmt) ) { - addType = attrValue.substring(attrValue.lastIndexOf('.')+1); - if ( addTypeV == null ) - addTypeV = new Vector(); - addTypeV.add(addType); - } - - } - if ( attrName.equals("xml-key")) { - elementIsKey = attrValue; - path += "/{" + elementName + "}"; - } - if ( attrName.equals("required")) { - elementIsRequired = attrValue; - } - if ( attrName.equals("container-type")) { - elementContainerType = attrValue; - } - } - if ( getItemName != null ) { - if ( getItemName.equals("array") ) { - if ( elementContainerType != null && elementContainerType.equals("java.util.ArrayList")) { - logger.trace( " returning array " + elementName ); - return elementName; - } - - } else { // not an array check - if ( elementContainerType == null || !elementContainerType.equals("java.util.ArrayList")) { - logger.trace( " returning object " + elementName ); - return elementName; - } - - } - logger.trace( " returning null" ); - return null; - } - if ( elementIsRequired != null ) { - if ( requiredCnt == 0 ) - sbRequired.append(" required:\n"); - ++requiredCnt; - if ( addTypeV != null ) { - for ( int k = 0; k < addTypeV.size(); ++i ) { - sbRequired.append(" - " + getXmlRootElementName(addTypeV.elementAt(k)) + ":\n"); - } - } else - sbRequired.append(" - " + elementName + "\n"); - - } - - if ( elementIsKey != null ) { - sbParameters.append((" - name: " + elementName + "\n")); - sbParameters.append((" in: path\n")); - if ( attrDescription != null && attrDescription.length() > 0 ) - sbParameters.append((" description: " + attrDescription + "\n")); - sbParameters.append((" required: true\n")); - if ( elementType.equals("java.lang.String")) - sbParameters.append(" type: string\n"); - if ( elementType.equals("java.lang.Long")) { - sbParameters.append(" type: integer\n"); - sbParameters.append(" format: int64\n"); - } - if ( elementType.equals("java.lang.Integer")) { - sbParameters.append(" type: integer\n"); - sbParameters.append(" format: int32\n"); - } - if ( elementType.equals("java.lang.Boolean")) { - sbParameters.append(" type: boolean\n"); - } - if(StringUtils.isNotBlank(elementName)) { - sbParameters.append(" example: "+"__"+elementName.toUpperCase()+"__"+"\n"); - } - } else if ( indexedProps != null - && indexedProps.contains(elementName ) ) { - sbIndexedParams.append((" - name: " + elementName + "\n")); - sbIndexedParams.append((" in: query\n")); - if ( attrDescription != null && attrDescription.length() > 0 ) - sbIndexedParams.append((" description: " + attrDescription + "\n")); - sbIndexedParams.append((" required: false\n")); - if ( elementType.equals("java.lang.String")) - sbIndexedParams.append(" type: string\n"); - if ( elementType.equals("java.lang.Long")) { - sbIndexedParams.append(" type: integer\n"); - sbIndexedParams.append(" format: int64\n"); - } - if ( elementType.equals("java.lang.Integer")) { - sbIndexedParams.append(" type: integer\n"); - sbIndexedParams.append(" format: int32\n"); - } - if ( elementType.equals("java.lang.Boolean")) - sbIndexedParams.append(" type: boolean\n"); - } - if ( isStandardType(elementType)) { - sbProperties.append(" " + elementName + ":\n"); - ++propertyCnt; - sbProperties.append(" type: "); - - if ( elementType.equals("java.lang.String")) - sbProperties.append("string\n"); - else if ( elementType.equals("java.lang.Long")) { - sbProperties.append("integer\n"); - sbProperties.append(" format: int64\n"); - } - else if ( elementType.equals("java.lang.Integer")){ - sbProperties.append("integer\n"); - sbProperties.append(" format: int32\n"); - } - else if ( elementType.equals("java.lang.Boolean")) - sbProperties.append("boolean\n"); - if ( attrDescription != null && attrDescription.length() > 0 ) - sbProperties.append(" description: " + attrDescription + "\n"); - } - - if ( addTypeV != null ) { - StringBuffer newPathParams = null; - if ( pathParams != null ) { - newPathParams = new StringBuffer(); - newPathParams.append(pathParams); - } - if ( sbParameters.toString().length() > 0 ) { - if ( newPathParams == null ) - newPathParams = new StringBuffer(); - newPathParams.append(sbParameters); - } - String newQueryParams = null; - if ( sbIndexedParams.toString().length() > 0 ) { - if ( queryParams == null ) - newQueryParams = sbIndexedParams.toString(); - else - newQueryParams = queryParams + sbIndexedParams.toString(); - } else { - newQueryParams = queryParams; - } - for ( int k = 0; k < addTypeV.size(); ++k ) { - addType = addTypeV.elementAt(k); - - if ( opId == null || !opId.contains(addType)) { - processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), - pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, null, - newPathParams, newQueryParams, validEdges); - } - // need item name of array - String itemName = processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), - pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, - "array", null, null, null ); - - if ( itemName != null ) { - if ( addType.equals("AaiInternal") ) { - logger.debug( "addType AaiInternal, skip properties"); - - } else if ( getItemName == null) { - ++propertyCnt; - sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); - sbProperties.append(" type: array\n items:\n"); - sbProperties.append(" $ref: \"#/definitions/" + (itemName == "" ? "aai-internal" : itemName) + "\"\n"); - if ( attrDescription != null && attrDescription.length() > 0 ) - sbProperties.append(" description: " + attrDescription + "\n"); - } - } else { - if ( elementContainerType != null && elementContainerType.equals("java.util.ArrayList")) { - // need properties for getXmlRootElementName(addType) - newPathParams = null; - if ( pathParams != null ) { - newPathParams = new StringBuffer(); - newPathParams.append(pathParams); - } - if ( sbParameters.toString().length() > 0 ) { - if ( newPathParams == null ) - newPathParams = new StringBuffer(); - newPathParams.append(sbParameters); - } - newQueryParams = null; - if ( sbIndexedParams.toString().length() > 0 ) { - if ( queryParams == null ) - newQueryParams = sbIndexedParams.toString(); - else - newQueryParams = queryParams + sbIndexedParams.toString(); - } else { - newQueryParams = queryParams; - } - processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), - pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, - null, newPathParams, newQueryParams, validEdges ); - sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); - sbProperties.append(" type: array\n items: \n"); - sbProperties.append(" $ref: \"#/definitions/" + getXmlRootElementName(addType) + "\"\n"); - } else { - sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); - sbProperties.append(" type: object\n"); - sbProperties.append(" $ref: \"#/definitions/" + getXmlRootElementName(addType) + "\"\n"); - } - if ( attrDescription != null && attrDescription.length() > 0 ) - sbProperties.append(" description: " + attrDescription + "\n"); - ++propertyCnt; - } - } - } - } - } - if ( genPath ) { - if ( !path.endsWith("/relationship") ) { - GetOperation get = new GetOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); - pathSb.append(get.toString()); -// if ( path.indexOf('{') > 0 ) { - - if ( sbParameters.toString().length() > 0 ) { - if ( pathParams == null ) - pathParams = new StringBuffer(); - pathParams.append(sbParameters); - } - if ( pathParams != null) { - pathSb.append(" parameters:\n"); - pathSb.append(pathParams); - } else - logger.trace( "null pathParams for " + useOpId); - if ( sbIndexedParams.toString().length() > 0 ) { - if ( queryParams == null ) - queryParams = sbIndexedParams.toString(); - else - queryParams = queryParams + sbIndexedParams.toString(); - } - if ( queryParams != null ) { - if ( pathParams == null ) { - pathSb.append(" parameters:\n"); - } - pathSb.append(queryParams); - } -// } - } - boolean skipPutDelete = false; // no put or delete for "all" - if ( !path.endsWith("/relationship") ) { - if ( !path.endsWith("}") ){ - skipPutDelete = true; - } - - } - if ( path.indexOf('{') > 0 && !opId.startsWith("Search") &&!skipPutDelete) { - // add PUT - PutOperation put = new PutOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); - pathSb.append(put.toString()); - if ( !path.endsWith("/relationship") ) { - PatchOperation patch = new PatchOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); - pathSb.append(patch.toString1()); - } - logger.debug(put.tagRelationshipPathMapEntry()); - - // add DELETE - DeleteOperation del = new DeleteOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); - pathSb.append(del.toString()); - logger.debug(del.objectPathMapEntry()); - } - - } - if ( generatedJavaType.containsKey(xmlRootElementName) ) { - return null; - } - - definitionsSb.append(" " + xmlRootElementName + ":\n"); - definitionsLocalSb.append(" " + xmlRootElementName + ":\n"); - Collection edges = getEdgeRules(xmlRootElementName ); - - if ( edges.size() > 0 ) { - StringBuffer sbEdge = new StringBuffer(); - sbEdge.append(" ###### Related Nodes\n"); - for (EdgeDescription ed : edges) { - if ( ed.getRuleKey().startsWith(xmlRootElementName)) { - sbEdge.append(" - TO ").append(ed.getRuleKey().substring(ed.getRuleKey().indexOf("|")+1)); - sbEdge.append(ed.getRelationshipDescription("TO", xmlRootElementName)); - sbEdge.append("\n"); - } - } - for (EdgeDescription ed : edges) { - if ( ed.getRuleKey().endsWith(xmlRootElementName)) { - sbEdge.append(" - FROM ").append(ed.getRuleKey().substring(0, ed.getRuleKey().indexOf("|"))); - sbEdge.append(ed.getRelationshipDescription("FROM", xmlRootElementName)); - sbEdge.append("\n"); - } - } - // Delete rule processing is incorrect. One cannot express the delete rules in isolation from the - // specific edge. Take the case of allotted-resource and service-instance. When the service-instance owns the - // allotted-resource, yes, it deletes it. But when the service-instance only uses the allotted-resource, the deletion - // of the service instance does not cause the deletion of the allotted-resource. - // I put some lines into the toDeleteRules and fromDeleteRules to correct things to an extent, but it's still - // not right. - sbEdge.append(toDeleteRules(xmlRootElementName)); - sbEdge.append(fromDeleteRules(xmlRootElementName)); - validEdges = sbEdge.toString(); - } - - // Handle description property. Might have a description OR valid edges OR both OR neither. - // Only put a description: tag if there is at least one. - if (pathDescriptionProperty != null || validEdges != null) { - definitionsSb.append(" description: |\n"); - definitionsLocalSb.append(" description: |\n"); - - if ( pathDescriptionProperty != null ) { - definitionsSb.append(" " + pathDescriptionProperty + "\n" ); - definitionsLocalSb.append(" " + pathDescriptionProperty + "\n" ); - } - if (validEdges != null) { - definitionsSb.append(validEdges); - definitionsLocalSb.append(validEdges); - } - } - - if ( requiredCnt > 0 ) { - definitionsSb.append(sbRequired); - definitionsLocalSb.append(sbRequired); - } - - if ( propertyCnt > 0 ) { - definitionsSb.append(" properties:\n"); - definitionsSb.append(sbProperties); - definitionsLocalSb.append(" properties:\n"); - definitionsLocalSb.append(sbProperties); - } - try { - javaTypeDefinitions.put(xmlRootElementName, definitionsLocalSb.toString()); - } catch (Exception e) { - e.printStackTrace(); - } - generatedJavaType.put(xmlRootElementName, null); - return null; - } - - public static void generateRelations() { - if(putRelationPaths == null) - return; - putRelationPaths.forEach((k,v)->{ - logger.trace("k="+k+"\n"+"v="+v+v.equals("/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship")); - logger.debug("apiPath(Operation): "+v); - logger.debug("Target object: "+v.replace("/relationship-list/relationship", "")); - logger.debug("Relations: "); - PutRelationPathSet prp = new PutRelationPathSet(k, v); - prp.process(); - }); - } - - public static String generateSwaggerFromOxmFile( File oxmFile, String xml ) - { - if ( xml != null ){ - apiVersion = Version.getLatest().toString(); - apiVersionFmt = "." + apiVersion + "."; - generatedJavaType = new HashMap<>(); - appliedPaths = new HashMap<>(); - responsesUrl = "Description: response-label\n"; - } - StringBuffer sb = new StringBuffer(); - sb.append("swagger: \"2.0\"\ninfo:\n "); - sb.append("description: |"); - sb.append("\n\n [Differences versus the previous schema version]("+"apidocs/aai_swagger_" + apiVersion + ".diff)"); - sb.append("\n\n Copyright © 2017 AT&T Intellectual Property. All rights reserved.\n\n Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.\n\n You may obtain a copy of the License at\n\n (https://creativecommons.org/licenses/by/4.0/)\n\n Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\n ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.\n\n This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.\n version: \"" + apiVersion +"\"\n"); - sb.append(" title: Active and Available Inventory REST API\n"); - sb.append(" license:\n name: Apache 2.0\n url: http://www.apache.org/licenses/LICENSE-2.0.html\n"); - sb.append(" contact:\n name:\n url:\n email:\n"); - sb.append("host:\nbasePath: /aai/" + apiVersion + "\n"); - sb.append("schemes:\n - https\npaths:\n"); - - try { - File initialFile; - if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(normalStartDir)) { - initialFile = new File(normalStartDir + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); - } - else { - initialFile = new File("src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); - } - InputStream is = new FileInputStream(initialFile); - - Scanner scanner = new Scanner(is); - jsonEdges = scanner.useDelimiter("\\Z").next(); - scanner.close(); - is.close(); - - DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); - dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); - DocumentBuilder dBuilder = dbFactory.newDocumentBuilder(); - Document doc; - - if ( xml == null ) { - doc = dBuilder.parse(oxmFile); - } else { - InputSource isInput = new InputSource(new StringReader(xml)); - doc = dBuilder.parse(isInput); - } - - NodeList bindingsNodes = doc.getElementsByTagName("xml-bindings"); - Element bindingElement; - NodeList javaTypesNodes; - Element javaTypesElement; - - Element javaTypeElement; - - - if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - - bindingElement = (Element) bindingsNodes.item(0); - javaTypesNodes = bindingElement.getElementsByTagName("java-types"); - if ( javaTypesNodes.getLength() < 1 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - javaTypesElement = (Element) javaTypesNodes.item(0); - - javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); - if ( javaTypeNodes.getLength() < 1 ) { - logger.error( "missing in " + oxmFile ); - return null; - } - - String javaTypeName; - String attrName, attrValue; - Attr attr; - StringBuffer pathSb = new StringBuffer(); - - StringBuffer definitionsSb = new StringBuffer(); - for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { - javaTypeElement = (Element) javaTypeNodes.item(i); - NamedNodeMap attributes = javaTypeElement.getAttributes(); - javaTypeName = null; - for ( int j = 0; j < attributes.getLength(); ++j ) { - attr = (Attr) attributes.item(j); - attrName = attr.getNodeName(); - attrValue = attr.getNodeValue(); - if ( attrName.equals("name")) - javaTypeName = attrValue; - } - if ( javaTypeName == null ) { - logger.error( " has no name attribute in " + oxmFile ); - return null; - } - if ( !generatedJavaType.containsKey(getXmlRootElementName(javaTypeName)) ) { - - processJavaTypeElementSwagger( javaTypeName, javaTypeElement, pathSb, - definitionsSb, null, null, null, null, null, null, null); - } - } - sb.append(pathSb); - } catch (Exception e) { - e.printStackTrace(); - return null; - } - //append definitions - sb.append("definitions:\n"); - Map sortedJavaTypeDefinitions = new TreeMap(javaTypeDefinitions); - for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { - logger.debug("Key: "+entry.getKey()+"Test: "+ (entry.getKey() == "relationship")); - if(entry.getKey().matches("relationship")) { - String jb=entry.getValue(); - logger.debug("Value: "+jb); - int ndx=jb.indexOf("related-to-property:"); - if(ndx > 0) { - jb=jb.substring(0, ndx); - jb=jb.replaceAll(" +$", ""); - } - logger.debug("Value-after: "+jb); - sb.append(jb); - continue; - } - sb.append(entry.getValue()); - } - - sb.append("patchDefinitions:\n"); - for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { - String jb=entry.getValue().replaceAll("/definitions/", "/patchDefinitions/"); - int ndx=jb.indexOf("relationship-list:"); - if(ndx > 0) { - jb=jb.substring(0, ndx); - jb=jb.replaceAll(" +$", ""); - } - int ndx1=jb.indexOf("resource-version:"); - logger.debug("Key: "+entry.getKey()+" index: " + ndx1); - logger.debug("Value: "+jb); - if(ndx1 > 0) { - jb=jb.substring(0, ndx1); - jb=jb.replaceAll(" +$", ""); - } - logger.debug("Value-after: "+jb); - sb.append(jb); - } - - sb.append("getDefinitions:\n"); - for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { - String jb=entry.getValue().replaceAll("/definitions/", "/getDefinitions/"); - sb.append(jb); - } - - logger.debug("generated " + sb.toString()); - generateRelations(); - return sb.toString(); - } - - private static NodeList locateXmlProperties(Element element) { - XPathExpression expr; - NodeList result = null; - try { - expr = xpath.compile("xml-properties"); - if (expr != null) { - Object nodeset = expr.evaluate(element, XPathConstants.NODESET); - if (nodeset != null) { - NodeList nodes = (NodeList) nodeset; - if (nodes != null && nodes.getLength() > 0) { - Element xmlProperty = (Element)nodes.item(0); - result = xmlProperty.getElementsByTagName("xml-property"); - } - } - } - } catch (XPathExpressionException e) { - e.printStackTrace(); + logger.debug( "GeneratedXSD successful, saved in " + outfileName); } - return result; } } \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteFootnoteSet.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteFootnoteSet.java new file mode 100644 index 00000000..dca5b7ce --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteFootnoteSet.java @@ -0,0 +1,57 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import java.util.Set; +import java.util.TreeSet; + +public class DeleteFootnoteSet { + protected Set footnotes = new TreeSet<>(); + protected String targetNode = ""; + public DeleteFootnoteSet(String targetNode) { + super(); + this.targetNode = targetNode == null ? "" : targetNode; + } + + public void add(String s ) { + String fullnote=null; + if("(1)".equals(s)) { + fullnote = s+" IF this "+targetNode.toUpperCase()+" node is deleted, this FROM node is DELETED also"; + } else if("(2)".equals(s)) { + fullnote = s+" IF this "+targetNode.toUpperCase()+" node is deleted, this TO node is DELETED also"; + } else if("(3)".equals(s)) { + fullnote = s+" IF this FROM node is deleted, this "+targetNode.toUpperCase()+" is DELETED also"; + } else if("(4)".equals(s)) { + fullnote = s+" IF this TO node is deleted, this "+targetNode.toUpperCase()+" is DELETED also"; + } else if(s.contains(targetNode.toUpperCase())) { + fullnote = s; + } else { + return; + } + footnotes.add(fullnote); + } + + public String toString() { + StringBuilder sb = new StringBuilder(); + if(footnotes.size() > 0) sb.append("\n -"); + sb.append(String.join("\n -", footnotes)+"\n"); + return sb.toString(); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteOperation.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteOperation.java new file mode 100644 index 00000000..0651566e --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/DeleteOperation.java @@ -0,0 +1,106 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.util.GenerateXsd; + +import java.util.HashMap; +import java.util.StringTokenizer; + +public class DeleteOperation { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + + public static HashMap deletePaths = new HashMap(); + public DeleteOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams = pathParams; + } + @Override + public String toString() { + StringTokenizer st; + st = new StringTokenizer(path, "/"); + //a valid tag is necessary + if ( StringUtils.isEmpty(tag) ) { + return ""; + } + if ( path.contains("/relationship/") ) { // filter paths with relationship-list + return ""; + } + if ( path.endsWith("/relationship-list")) { + return ""; + } + if ( path.startsWith("/search")) { + return ""; + } + //All Delete operation paths end with "relationship" + //or there is a parameter at the end of the path + //and there is a parameter in the path + + if ( !path.endsWith("/relationship") && !path.endsWith("}") ) { + return ""; + } + StringBuffer pathSb = new StringBuffer(); + pathSb.append(" delete:\n"); + pathSb.append(" tags:\n"); + pathSb.append(" - " + tag + "\n"); + pathSb.append(" summary: delete an existing " + xmlRootElementName + "\n"); + + pathSb.append(" description: delete an existing " + xmlRootElementName + "\n"); + + pathSb.append(" operationId: delete" + useOpId + "\n"); + pathSb.append(" consumes:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" produces:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" responses:\n"); + pathSb.append(" \"default\":\n"); + pathSb.append(" " + GenerateXsd.getResponsesUrl()); + pathSb.append(" parameters:\n"); + + pathSb.append(pathParams); // for nesting + if ( !path.endsWith("/relationship") ) { + pathSb.append(" - name: resource-version\n"); + + pathSb.append(" in: query\n"); + pathSb.append(" description: resource-version for concurrency\n"); + pathSb.append(" required: true\n"); + pathSb.append(" type: string\n"); + } + this.objectPathMapEntry(); + return pathSb.toString(); + } + public String objectPathMapEntry() { + if (! path.endsWith("/relationship") ) { + deletePaths.put(path, xmlRootElementName); + } + return (xmlRootElementName+":"+path); + } + } \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeDescription.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeDescription.java new file mode 100644 index 00000000..6e1294ab --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeDescription.java @@ -0,0 +1,242 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class EdgeDescription { + private static final Logger logger = LoggerFactory.getLogger("EdgeDescription.class"); + + public static enum LineageType { + PARENT, CHILD, UNRELATED; + } + private String ruleKey; + private String to; + private String from; + private LineageType type = LineageType.UNRELATED; + private String direction; + private String multiplicity; + private String preventDelete; + private String deleteOtherV; + private String label; + private String description; + /** + * @return the deleteOtherV + */ + public String getDeleteOtherV() { + return deleteOtherV; + } + /** + * @param deleteOtherV the deleteOtherV to set + */ + public void setDeleteOtherV(String deleteOtherV) { + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("Truth: "+(("${direction}".equals(deleteOtherV)) ? "true" : "false")); + logger.debug("Truth: "+(("!${direction}".equals(deleteOtherV)) ? "true" : "false")); + + if("${direction}".equals(deleteOtherV) ) { + this.deleteOtherV = this.direction; + } else if("!${direction}".equals(deleteOtherV) ) { + this.deleteOtherV = this.direction.equals("IN") ? "OUT" : ((this.direction.equals("OUT")) ? "IN" : deleteOtherV); + } else { + this.deleteOtherV = deleteOtherV; + } + logger.debug("DeleteOtherV="+deleteOtherV+"/"+this.direction+"="+this.deleteOtherV); + } + /** + * @return the preventDelete + */ + public String getPreventDelete() { + return preventDelete; + } + /** + * @param preventDelete the preventDelete to set + */ + public void setPreventDelete(String preventDelete) { + if(this.getTo().equals("flavor") || this.getFrom().equals("flavor") ){ + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("Truth: "+(("${direction}".equals(preventDelete)) ? "true" : "false")); + logger.debug("Truth: "+(("!${direction}".equals(preventDelete)) ? "true" : "false")); + } + + if("${direction}".equals(preventDelete) ) { + this.preventDelete = this.direction; + } else if("!${direction}".equals(preventDelete) ) { + this.preventDelete = this.direction.equals("IN") ? "OUT" : ((this.direction.equals("OUT")) ? "IN" : preventDelete); + } else { + this.preventDelete = preventDelete; + } + } + public String getAlsoDeleteFootnote(String targetNode) { + String returnVal = ""; + if(this.deleteOtherV.equals("IN") && this.to.equals(targetNode) ) { + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("IF this "+targetNode+" node is deleted, this FROM node is DELETED also"); + returnVal = "(1)"; + } + if(this.deleteOtherV.equals("OUT") && this.from.equals(targetNode) ) { + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("IF this "+targetNode+" is deleted, this TO node is DELETED also"); + returnVal = "(2)"; + } + if(this.deleteOtherV.equals("OUT") && this.to.equals(targetNode) ) { + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("IF this FROM node is deleted, this "+targetNode+" is DELETED also"); + returnVal = "(3)"; + } + if(this.deleteOtherV.equals("IN") && this.from.equals(targetNode) ) { + logger.debug("Edge: "+this.getRuleKey()); + logger.debug("IF this TO node is deleted, this "+targetNode+" node is DELETED also"); + returnVal = "(4)"; + } + return returnVal; + } + /** + * @return the to + */ + public String getTo() { + return to; + } + /** + * @param to the to to set + */ + public void setTo(String to) { + this.to = to; + } + /** + * @return the from + */ + public String getFrom() { + return from; + } + /** + * @param from the from to set + */ + public void setFrom(String from) { + this.from = from; + } + + + public String getRuleKey() { + return ruleKey; + } + public String getMultiplicity() { + return multiplicity; + } + public String getDirection() { + return direction; + } + public String getDescription() { + return this.description; + } + public void setRuleKey(String val) { + this.ruleKey=val; + } + public void setType(LineageType val) { + this.type=val; + } + public void setDirection(String val) { + this.direction = val; + } + public void setMultiplicity(String val) { + this.multiplicity=val; + } + + public void setDescription(String val) { + this.description = val; + } + + public String getRelationshipDescription(String fromTo, String otherNodeName) { + + String result = ""; + + if ("FROM".equals(fromTo)) { + if ("OUT".equals(direction)) { + if (LineageType.PARENT == type) { + result = " (PARENT of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getShortLabel(), this.to); + } + } + else { + if (LineageType.CHILD == type) { + result = " (CHILD of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getShortLabel(), this.to); + } + else if (LineageType.PARENT == type) { + result = " (PARENT of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getShortLabel(), this.to); + } + } + if (result.length() == 0) result = String.join(" ", "(", this.from, this.getShortLabel(), this.to+",", this.getMultiplicity()); + } else { + //if ("TO".equals(fromTo) + if ("OUT".equals(direction)) { + if (LineageType.PARENT == type) { + result = " (CHILD of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getShortLabel(), this.to+",", this.getMultiplicity()); + } + } else { + if (LineageType.PARENT == type) { + result = " (PARENT of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getShortLabel(), this.to+",", this.getMultiplicity()); + } + } + if (result.length() == 0) result = String.join(" ", "(", this.from, this.getShortLabel(), this.to+",", this.getMultiplicity()); + } +// Confusing... +// if (hasDelTarget()) result = result + ", will delete target node"; + + if (result.length() > 0) result = result + ")"; + + if (description != null && description.length() > 0) result = result + "\n "+ description; // 6 spaces is important for yaml + + return result; + } + + /** + * @return the hasDelTarget + */ + + public boolean hasDelTarget() { + return StringUtils.isNotEmpty(this.deleteOtherV) && (! "NONE".equalsIgnoreCase(this.deleteOtherV)); + } + + /** + * @return the type + */ + public LineageType getType() { + return type; + } + /** + * @return the label + */ + public String getLabel() { + return label; + } + public String getShortLabel() { + String[] pieces = this.getLabel().split("[.]"); + return pieces[pieces.length-1]; + } + public void setLabel(String string) { + this.label=string; + } +} \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeRuleSet.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeRuleSet.java new file mode 100644 index 00000000..f3ef298a --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/EdgeRuleSet.java @@ -0,0 +1,196 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import org.onap.aai.serialization.db.EdgeProperty; + +import java.io.*; +import java.util.*; + +public class EdgeRuleSet { + private File edgeFile; + private DocumentContext jsonContext; + + public EdgeRuleSet(File edgeFile) throws IOException,FileNotFoundException { + this.edgeFile = edgeFile; + init(); + } + public EdgeRuleSet(DocumentContext jsonContext) { + this.jsonContext = jsonContext; + } + + public Collection getEdgeRules( String nodeName ) + { + String fromRulesPath = "$['rules'][?(@['from']=='" + nodeName + "')]"; + String toRulesPath = "$['rules'][?(@['to']=='" + nodeName + "')]"; + Collection fromEdges = getEdgeRulesFromJson( fromRulesPath, false ); + Collection edges = getEdgeRulesFromJson( toRulesPath, true ); + edges.addAll(fromEdges); + return edges; + } + + public Collection getEdgeRulesTO( String nodeName ) + { + String toRulesPath = "$['rules'][?(@['to']=='" + nodeName + "')]"; + Collection edges = getEdgeRulesFromJson( toRulesPath, true ); + return edges; + } + + public Collection getEdgeRulesFROM( String nodeName ) + { + String fromRulesPath = "$['rules'][?(@['from']=='" + nodeName + "')]"; + Collection edges = getEdgeRulesFromJson( fromRulesPath, true ); + return edges; + } + + /** + * Guaranteed to at least return non null but empty collection of edge descriptions + * @param nodeName name of the vertex whose edge relationships to return + * @return collection of node neighbors based on DbEdgeRules + **/ + public Collection getEdgeRulesFromJson( String path, boolean skipMatch ) + { + + ArrayList result = new ArrayList<>(); + Iterator> edgeRulesIterator; + try { + List> inEdges = jsonContext.read(path); + + edgeRulesIterator = inEdges.iterator(); + Map edgeMap; + String fromNode; + String toNode; + String direction; + String multiplicity; + String isParent; + String deleteOtherV; + String preventDelete; + String description; + EdgeDescription edgeDes; + + while( edgeRulesIterator.hasNext() ){ + edgeMap = edgeRulesIterator.next(); + fromNode = (String)edgeMap.get("from"); + toNode = (String)edgeMap.get("to"); + if ( skipMatch ) { + if ( fromNode.equals(toNode)) { + continue; + } + } + edgeDes = new EdgeDescription(); + edgeDes.setRuleKey(fromNode + "|" + toNode); + edgeDes.setLabel((String)edgeMap.get("label")); + edgeDes.setTo((String)edgeMap.get("to")); + edgeDes.setFrom((String)edgeMap.get("from")); + direction = (String)edgeMap.get("direction"); + edgeDes.setDirection(direction); + multiplicity = (String)edgeMap.get("multiplicity"); + edgeDes.setMultiplicity(multiplicity); + isParent = (String)edgeMap.get(EdgeProperty.CONTAINS.toString()); + if ( "${direction}".equals(isParent)) { + edgeDes.setType(EdgeDescription.LineageType.PARENT); + } else { + edgeDes.setType(EdgeDescription.LineageType.UNRELATED); + } + deleteOtherV = (String)edgeMap.get(EdgeProperty.DELETE_OTHER_V.toString()); + edgeDes.setDeleteOtherV(deleteOtherV); + preventDelete = (String)edgeMap.get(EdgeProperty.PREVENT_DELETE.toString()); + edgeDes.setPreventDelete(preventDelete); + description = (String)edgeMap.get(EdgeProperty.DESCRIPTION.toString()); + edgeDes.setDescription(description); + + result.add(edgeDes); +// logger.debug("Edge: "+edgeDes.getRuleKey()); + } + } catch (Exception ex) { + ex.printStackTrace(); + } + return result; + + } + + private void init() throws FileNotFoundException, IOException { + InputStream is = null; + Scanner scanner = null; + String jsonEdges = null; + try { + is = new FileInputStream(edgeFile); + scanner = new Scanner(is); + jsonEdges = scanner.useDelimiter("\\Z").next(); + } catch (Exception e) { + throw e; + } finally { + scanner.close(); + if (is != null) { + try { + is.close(); + } catch (IOException e) { + throw e; + } + } + } + jsonContext = JsonPath.parse(jsonEdges); + } + + public String preventDeleteRules(String objectName) { + Collection toEdges = getEdgeRulesTO(objectName); + toEdges.addAll(getEdgeRulesFROM(objectName)); +// logger.debug("TO Edges count: "+toEdges.size()+" Object: "+objectName); + String prevent=null; + LinkedHashSet preventDelete = new LinkedHashSet(); + for (EdgeDescription ed : toEdges) { +// logger.debug("{“comment”: From = "+ed.getFrom()+" To: "+ed.getTo()+" Object: "+objectName); +// logger.debug("{“comment”: Direction = "+ed.getDirection()+" PreventDelete: "+ed.getPreventDelete()+" DeleteOtherV: "+ed.getDeleteOtherV()+" Object: "+objectName); + if(ed.getPreventDelete().equals("IN") && ed.getTo().equals(objectName)) { + preventDelete.add(ed.getFrom().toUpperCase()); + } + if(ed.getPreventDelete().equals("OUT") && ed.getFrom().equals(objectName)) { + preventDelete.add(ed.getTo().toUpperCase()); + } + } + if(preventDelete.size() > 0) { + prevent = objectName.toUpperCase()+" cannot be deleted if related to "+String.join(",",preventDelete); +// logger.debug(prevent); + } + return String.join((prevent == null) ? "" : "\n", prevent == null ? "" : prevent)+((prevent == null) ? "" : "\n"); +// return String.join((prevent == null) ? "" : "\n", prevent == null ? "" : prevent, also == null ? "" : also)+((prevent == null) ? "" : "\n"); + } + + public String fromDeleteRules(String objectName) { + Collection fromEdges = getEdgeRulesFROM(objectName); + LinkedHashSet preventDelete = new LinkedHashSet (); + String prevent=null; + String also=null; + for (EdgeDescription ed : fromEdges) { +// logger.debug("{“comment”: From = "+ed.getFrom()+" To: "+ed.getTo()+" Object: "+objectName); +// logger.debug("{“comment”: Direction = "+ed.getDirection()+" PreventDelete: "+ed.getPreventDelete()+" DeleteOtherV: "+ed.getDeleteOtherV()+" Object: "+objectName); + if(ed.getPreventDelete().equals("OUT") && ed.getFrom().equals(objectName)) { + preventDelete.add(ed.getTo().toUpperCase()); + } + } + if(preventDelete.size() > 0) { + prevent = objectName.toUpperCase()+" cannot be deleted if related to "+String.join(",",preventDelete); +// logger.debug(prevent); + } + return String.join((prevent == null || also == null) ? "" : "\n", prevent == null ? "" : prevent, also == null ? "" : also)+((prevent == null && also == null) ? "" : "\n"); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/GetOperation.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/GetOperation.java new file mode 100644 index 00000000..16a2e682 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/GetOperation.java @@ -0,0 +1,121 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.util.GenerateXsd; + +import java.util.HashMap; +import java.util.Map; +import java.util.StringTokenizer; +import java.util.Vector; + +public class GetOperation { + static Map> containers = new HashMap>(); + public static void addContainerProps(String container, Vector containerProps) { + containers.put(container, containerProps);; + } + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private String queryParams; + + public GetOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams = pathParams; +// StringBuilder p = new StringBuilder(); + + if(containers.get(xmlRootElementName) == null) { + this.queryParams = ""; + } else { + this.queryParams= String.join("", containers.get(xmlRootElementName)); +// for(String param : containers.get(xmlRootElementName)) { +// p.append(param); +// } +// this.queryParams = p.toString(); + } + } + @Override + public String toString() { + StringTokenizer st; + st = new StringTokenizer(path, "/"); + //Path has to be longer than one element + /* + if ( st.countTokens() <= 1) { + return ""; + } + */ + //a valid tag is necessary + if ( StringUtils.isEmpty(tag) ) { + return ""; + } + if ( path.endsWith("/relationship") ) { + return ""; + } + if ( path.contains("/relationship/") ) { // filter paths with relationship-list + return ""; + } + if ( path.endsWith("/relationship-list")) { + return ""; + } + if ( path.startsWith("/search")) { + return ""; + } + StringBuffer pathSb = new StringBuffer(); + pathSb.append(" " + path + ":\n" ); + pathSb.append(" get:\n"); + pathSb.append(" tags:\n"); + pathSb.append(" - " + tag + "\n"); + pathSb.append(" summary: returns " + xmlRootElementName + "\n"); + + pathSb.append(" description: returns " + xmlRootElementName + "\n"); + pathSb.append(" operationId: get" + useOpId + "\n"); + pathSb.append(" produces:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + + pathSb.append(" responses:\n"); + pathSb.append(" \"200\":\n"); + pathSb.append(" description: successful operation\n"); + pathSb.append(" schema:\n"); + pathSb.append(" $ref: \"#/getDefinitions/" + xmlRootElementName + "\"\n"); + pathSb.append(" \"default\":\n"); + pathSb.append(" " + GenerateXsd.getResponsesUrl()); + if ( StringUtils.isNotEmpty(pathParams) || StringUtils.isNotEmpty(queryParams)) { + pathSb.append(" parameters:\n"); + } + if ( StringUtils.isNotEmpty(pathParams)) { + pathSb.append(pathParams); + } +// if ( StringUtils.isNotEmpty(pathParams) && StringUtils.isNotEmpty(queryParams)) { +// pathSb.append("\n"); +// } + if ( StringUtils.isNotEmpty(queryParams)) { + pathSb.append(queryParams); + } + return pathSb.toString(); + } + } diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/HTMLfromOXM.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/HTMLfromOXM.java new file mode 100644 index 00000000..287b3b5c --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/HTMLfromOXM.java @@ -0,0 +1,190 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.Version; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Attr; +import org.w3c.dom.Element; +import org.w3c.dom.NamedNodeMap; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; + +import javax.xml.parsers.ParserConfigurationException; +import java.io.File; +import java.io.IOException; + +public class HTMLfromOXM extends OxmFileProcessor { + private static final Logger logger = LoggerFactory.getLogger("HTMLfromOXM.class"); + + Version v; + public HTMLfromOXM(File oxmFile, Version v) throws ParserConfigurationException, SAXException, IOException, AAIException { + super(oxmFile, v); + super.init(); + this.v = v; + } + public HTMLfromOXM(String xml, Version v) throws ParserConfigurationException, SAXException, IOException, AAIException { + super(xml, v); + super.init(); + this.v = v; + } + + @Override + public String getDocumentHeader() { + StringBuffer sb = new StringBuffer(); + logger.trace("processing starts"); + sb.append("\n"); + String namespace = "org.onap"; + if (v.compareTo(Version.v11) < 0 || v.compareTo(Version.v12) < 0) { + namespace = "org.openecomp"; + } + if ( versionUsesAnnotations(v.name()) ) { + sb.append("\n\n"); + } else { + sb.append("\n\n"); + } + return sb.toString(); + } + + @Override + public String process() throws AAIException { + StringBuilder sb = new StringBuilder(); + sb.append(getDocumentHeader()); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element)javaTypeNodes.item(i)); + String javaTypeName = javaTypeElement.name(); + if ( javaTypeName == null ) { + String msg = "Invalid OXM file: has no name attribute in " + oxmFile; + logger.error(msg); + throw new AAIException(msg); + } + if ("Nodes".equals(javaTypeName)) { + logger.debug("skipping Nodes entry (temporary feature)"); + continue; + } + //Skip any type that has already been processed(recursion could be the reason) + logger.debug(getXmlRootElementName(javaTypeName)+" vs "+ javaTypeName+":"+generatedJavaType.containsKey(getXmlRootElementName(javaTypeName))); + if ( generatedJavaType.containsKey(javaTypeName) ) { + continue; + } + generatedJavaType.put(javaTypeName, null); + sb.append(processJavaTypeElement( javaTypeName, javaTypeElement )); + } + sb.append("\n"); + return sb.toString(); + } + + public String processJavaTypeElement( String javaTypeName, Element javaType_Element) { + + String xmlRootElementName = getXMLRootElementName(javaType_Element); + + NodeList parentNodes = javaType_Element.getElementsByTagName("java-attributes"); + StringBuffer sb = new StringBuffer(); + if ( parentNodes.getLength() == 0 ) { + logger.trace( "no java-attributes for java-type " + javaTypeName); + return ""; + } + + Element parentElement = (Element)parentNodes.item(0); + NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); + + StringBuffer sb1 = new StringBuffer(); + if ( xmlElementNodes.getLength() > 0 ) { + sb1.append(" \n"); + sb1.append(" \n"); + XSDElement javaTypeElement = new XSDElement(javaType_Element); + logger.debug("XSDElement name: "+javaTypeElement.name()); + if(versionUsesAnnotations(v.name())) { + sb1.append(javaTypeElement.getHTMLAnnotation("class", " ")); + } + sb1.append(" \n"); + for ( int i = 0; i < xmlElementNodes.getLength(); ++i ) { + + XSDElement xmlElementElement = new XSDElement((Element)xmlElementNodes.item(i)); + + String elementName = xmlElementElement.getAttribute("name"); + String elementType = xmlElementElement.getAttribute("type"); + //No simple types; only AAI custom types + String addType = elementType.contains("." + v.name() + ".") ? elementType.substring(elementType.lastIndexOf('.')+1) : null; + if ( elementType.contains("." + v.name() + ".") && !generatedJavaType.containsKey(addType) ) { + generatedJavaType.put(addType, elementType); + sb.append(processJavaTypeElement( addType, getJavaTypeElement(addType) )); + } + if ("Nodes".equals(addType)) { + logger.trace("Skipping nodes, temporary testing"); + continue; + } + //assembles the basic + sb1.append(xmlElementElement.getHTMLElement(v, versionUsesAnnotations(v.name()), this)); + } + sb1.append(" \n"); + sb1.append(" \n"); + sb1.append(" \n"); + } + + if ( xmlElementNodes.getLength() < 1 ) { + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + generatedJavaType.put(javaTypeName, null); + return sb.toString(); + } + sb.append( sb1 ); + return sb.toString(); + } + + private Element getJavaTypeElement( String javaTypeName ) + { + String attrName, attrValue; + Attr attr; + Element javaTypeElement; + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + javaTypeElement = (Element) javaTypeNodes.item(i); + NamedNodeMap attributes = javaTypeElement.getAttributes(); + for ( int j = 0; j < attributes.getLength(); ++j ) { + attr = (Attr) attributes.item(j); + attrName = attr.getNodeName(); + attrValue = attr.getNodeValue(); + if ( attrName.equals("name") && attrValue.equals(javaTypeName)) + return javaTypeElement; + } + } + logger.error( "oxm file format error, missing java-type " + javaTypeName); + return (Element) null; + } + + private boolean versionUsesAnnotations( String version) { + if (new Integer(version.substring(1)).intValue() >= HTMLfromOXM.annotationsStartVersion ) { + return true; + } + return false; + } +} \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/OxmFileProcessor.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/OxmFileProcessor.java new file mode 100644 index 00000000..04fdd3c0 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/OxmFileProcessor.java @@ -0,0 +1,199 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.Version; +import org.w3c.dom.*; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; + +import javax.xml.XMLConstants; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import java.io.File; +import java.io.IOException; +import java.io.StringReader; +import java.util.HashMap; +import java.util.Map; + +public abstract class OxmFileProcessor { + protected File oxmFile; + protected String xml; + protected Version v; + protected Document doc = null; + protected String apiVersion = null; + protected static int annotationsStartVersion = 9; // minimum version to support annotations in xsd + protected static int swaggerSupportStartsVersion = 7; // minimum version to support swagger documentation + + protected String apiVersionFmt = null; + protected HashMap generatedJavaType = new HashMap(); + protected HashMap appliedPaths = new HashMap(); + protected NodeList javaTypeNodes = null; + protected static Map javaTypeDefinitions = createJavaTypeDefinitions(); + private static Map createJavaTypeDefinitions() + { + StringBuffer aaiInternal = new StringBuffer(); + StringBuffer nodes = new StringBuffer(); + Map javaTypeDefinitions = new HashMap(); + aaiInternal.append(" aai-internal:\n"); + aaiInternal.append(" properties:\n"); + aaiInternal.append(" property-name:\n"); + aaiInternal.append(" type: string\n"); + aaiInternal.append(" property-value:\n"); + aaiInternal.append(" type: string\n"); +// javaTypeDefinitions.put("aai-internal", aaiInternal.toString()); + nodes.append(" nodes:\n"); + nodes.append(" properties:\n"); + nodes.append(" inventory-item-data:\n"); + nodes.append(" type: array\n"); + nodes.append(" items:\n"); + nodes.append(" $ref: \"#/definitions/inventory-item-data\"\n"); + javaTypeDefinitions.put("nodes", nodes.toString()); + return javaTypeDefinitions; + } + + + public OxmFileProcessor(File oxmFile, Version v) { + super(); + this.oxmFile = oxmFile; + this.v = v; + } + + public OxmFileProcessor(String xml, Version v) { + this.xml = xml; + this.v = v; + } + protected void init() throws ParserConfigurationException, SAXException, IOException, AAIException { + DocumentBuilder dBuilder = null; + try { + DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); + dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); + dBuilder = dbFactory.newDocumentBuilder(); + } catch (ParserConfigurationException e) { + throw e; + } + try { + if ( xml == null ) { + doc = dBuilder.parse(oxmFile); + } else { + InputSource isInput = new InputSource(new StringReader(xml)); + doc = dBuilder.parse(isInput); + } + } catch (SAXException e) { + throw e; + } catch (IOException e) { + throw e; + } + + NodeList bindingsNodes = doc.getElementsByTagName("xml-bindings"); + Element bindingElement; + NodeList javaTypesNodes; + Element javaTypesElement; + + if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { + throw new AAIException("OXM file error: missing in " + oxmFile); + } + + bindingElement = (Element) bindingsNodes.item(0); + javaTypesNodes = bindingElement.getElementsByTagName("java-types"); + if ( javaTypesNodes.getLength() < 1 ) { + throw new AAIException("OXM file error: missing in " + oxmFile); + } + javaTypesElement = (Element) javaTypesNodes.item(0); + + javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); + if ( javaTypeNodes.getLength() < 1 ) { + throw new AAIException("OXM file error: missing in " + oxmFile ); + } + } + public abstract String getDocumentHeader(); + public abstract String process() throws AAIException; + + public String getXMLRootElementName(Element javaTypeElement) { + String xmlRootElementName=null; + NamedNodeMap attributes; + + NodeList valNodes = javaTypeElement.getElementsByTagName("xml-root-element"); + Element valElement = (Element) valNodes.item(0); + attributes = valElement.getAttributes(); + for ( int i = 0; i < attributes.getLength(); ++i ) { + Attr attr = (Attr) attributes.item(i); + String attrName = attr.getNodeName(); + + String attrValue = attr.getNodeValue(); + if ( attrName.equals("name")) + xmlRootElementName = attrValue; + } + return xmlRootElementName; + } + + public String getXmlRootElementName( String javaTypeName ) + { + String attrName, attrValue; + Attr attr; + Element javaTypeElement; + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + javaTypeElement = (Element) javaTypeNodes.item(i); + NamedNodeMap attributes = javaTypeElement.getAttributes(); + for ( int j = 0; j < attributes.getLength(); ++j ) { + attr = (Attr) attributes.item(j); + attrName = attr.getNodeName(); + attrValue = attr.getNodeValue(); + if ( attrName.equals("name") && attrValue.equals(javaTypeName)) { + NodeList valNodes = javaTypeElement.getElementsByTagName("xml-root-element"); + Element valElement = (Element) valNodes.item(0); + attributes = valElement.getAttributes(); + for ( int k = 0; k < attributes.getLength(); ++k ) { + attr = (Attr) attributes.item(k); + attrName = attr.getNodeName(); + + attrValue = attr.getNodeValue(); + if ( attrName.equals("name")) + return (attrValue); + } + } + } + } + return null; + } + + public Element getJavaTypeElementSwagger( String javaTypeName ) + { + + String attrName, attrValue; + Attr attr; + Element javaTypeElement; + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + javaTypeElement = (Element) javaTypeNodes.item(i); + NamedNodeMap attributes = javaTypeElement.getAttributes(); + for ( int j = 0; j < attributes.getLength(); ++j ) { + attr = (Attr) attributes.item(j); + attrName = attr.getNodeName(); + attrValue = attr.getNodeValue(); + if ( attrName.equals("name") && attrValue.equals(javaTypeName)) + return javaTypeElement; + } + } + return (Element) null; + } + +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/PatchOperation.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/PatchOperation.java new file mode 100644 index 00000000..cc90114f --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/PatchOperation.java @@ -0,0 +1,116 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.util.GenerateXsd; + +import java.util.StringTokenizer; + +public class PatchOperation { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + + public PatchOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams = pathParams; + } + + public String toString() { + StringTokenizer st; + st = new StringTokenizer(path, "/"); + //a valid tag is necessary + if ( StringUtils.isEmpty(tag) ) { + return ""; + } + if ( path.contains("/relationship/") ) { // filter paths with relationship-list + return ""; + } + if ( path.endsWith("/relationship-list")) { + return ""; + } + if ( path.startsWith("/search")) { + return ""; + } + //No Patch operation paths end with "relationship" + + if (path.endsWith("/relationship") ) { + return ""; + } + if (!path.endsWith("}")) { + return ""; + } + + StringBuffer pathSb = new StringBuffer(); + StringBuffer relationshipExamplesSb = new StringBuffer(); + if ( path.endsWith("/relationship") ) { + pathSb.append(" " + path + ":\n" ); + } + pathSb.append(" patch:\n"); + pathSb.append(" tags:\n"); + pathSb.append(" - " + tag + "\n"); + + if ( path.endsWith("/relationship") ) { + pathSb.append(" summary: see node definition for valid relationships\n"); + relationshipExamplesSb.append("[See Examples](apidocs/relations/"+ GenerateXsd.getAPIVersion()+"/"+useOpId+".json)"); + } else { + pathSb.append(" summary: update an existing " + xmlRootElementName + "\n"); + pathSb.append(" description: |\n"); + pathSb.append(" Update an existing " + xmlRootElementName + "\n"); + pathSb.append(" #\n"); + pathSb.append(" Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n"); + pathSb.append(" The PUT operation will entirely replace an existing object.\n"); + pathSb.append(" The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n"); + pathSb.append(" #\n"); + pathSb.append(" Other differences between PUT and PATCH are:\n"); + pathSb.append(" #\n"); + pathSb.append(" - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n"); + pathSb.append(" - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n"); + pathSb.append(" - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n"); + } + pathSb.append(" operationId: Update" + useOpId + "\n"); + pathSb.append(" consumes:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" produces:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" responses:\n"); + pathSb.append(" \"default\":\n"); + pathSb.append(" " + GenerateXsd.getResponsesUrl()); + pathSb.append(" parameters:\n"); + pathSb.append(pathParams); // for nesting + pathSb.append(" - name: body\n"); + pathSb.append(" in: body\n"); + pathSb.append(" description: " + xmlRootElementName + " object that needs to be updated."+relationshipExamplesSb.toString()+"\n"); + pathSb.append(" required: true\n"); + pathSb.append(" schema:\n"); + pathSb.append(" $ref: \"#/patchDefinitions/" + xmlRootElementName + "\"\n"); + return pathSb.toString(); + } + } + \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/PutOperation.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/PutOperation.java new file mode 100644 index 00000000..58ccec37 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/PutOperation.java @@ -0,0 +1,114 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.introspection.Version; +import org.onap.aai.util.GenerateXsd; + +import java.util.StringTokenizer; + +public class PutOperation { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private Version version; + + public PutOperation(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, Version v) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams = pathParams; + this.version = v; + } + + @Override + public String toString() { + StringTokenizer st = new StringTokenizer(path, "/"); + //a valid tag is necessary + if ( StringUtils.isEmpty(tag) ) { + return ""; + } + //All Put operation paths end with "relationship" + //or there is a parameter at the end of the path + //and there is a parameter in the path + if ( path.contains("/relationship/") ) { // filter paths with relationship-list + return ""; + } + if ( path.endsWith("/relationship-list")) { + return ""; + } + if ( !path.endsWith("/relationship") && !path.endsWith("}") ) { + return ""; + } + if ( path.startsWith("/search")) { + return ""; + } + StringBuffer pathSb = new StringBuffer(); + StringBuffer relationshipExamplesSb = new StringBuffer(); + if ( path.endsWith("/relationship") ) { + pathSb.append(" " + path + ":\n" ); + } + pathSb.append(" put:\n"); + pathSb.append(" tags:\n"); + pathSb.append(" - " + tag + "\n"); + + if ( path.endsWith("/relationship") ) { + pathSb.append(" summary: see node definition for valid relationships\n"); + } else { + pathSb.append(" summary: create or update an existing " + xmlRootElementName + "\n"); + pathSb.append(" description: |\n Create or update an existing " + xmlRootElementName + ".\n #\n Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n"); + } + relationshipExamplesSb.append("[Valid relationship examples shown here](apidocs/relations/"+version.name()+"/"+useOpId.replace("RelationshipListRelationship", "")+".json)"); + pathSb.append(" operationId: createOrUpdate" + useOpId + "\n"); + pathSb.append(" consumes:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" produces:\n"); + pathSb.append(" - application/json\n"); + pathSb.append(" - application/xml\n"); + pathSb.append(" responses:\n"); + pathSb.append(" \"default\":\n"); + pathSb.append(" " + GenerateXsd.getResponsesUrl()); + + pathSb.append(" parameters:\n"); + pathSb.append(pathParams); // for nesting + pathSb.append(" - name: body\n"); + pathSb.append(" in: body\n"); + pathSb.append(" description: " + xmlRootElementName + " object that needs to be created or updated. "+relationshipExamplesSb.toString()+"\n"); + pathSb.append(" required: true\n"); + pathSb.append(" schema:\n"); + pathSb.append(" $ref: \"#/definitions/" + xmlRootElementName + "\"\n"); + this.tagRelationshipPathMapEntry(); + return pathSb.toString(); + } + + public String tagRelationshipPathMapEntry() { + if ( path.endsWith("/relationship") ) { + PutRelationPathSet.add(useOpId, path); + } + return ""; + } + + } \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/PutRelationPathSet.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/PutRelationPathSet.java new file mode 100644 index 00000000..3e411946 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/PutRelationPathSet.java @@ -0,0 +1,216 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.text.similarity.LevenshteinDistance; +import org.onap.aai.introspection.Version; +import org.onap.aai.util.GenerateXsd; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.FileOutputStream; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; + +public class PutRelationPathSet { + private static final Logger logger = LoggerFactory.getLogger("PutRelationPathSet.class"); + protected static HashMap putRelationPaths = new HashMap(); + private static EdgeRuleSet edgeRuleSet = null; + public static void add(String useOpId, String path) { + putRelationPaths.put(useOpId, path); + } + + String apiPath; + String opId; + Version version; + protected ArrayList relations = new ArrayList(); + String objectName = ""; + + public PutRelationPathSet(Version v) { + this.version = v; + } + + public PutRelationPathSet(String opId, String path, Version v) { + this.apiPath = path.replace("/relationship-list/relationship", ""); + this.opId = opId; + this.version = v; + objectName = DeleteOperation.deletePaths.get(apiPath); + logger.debug("II-apiPath: "+apiPath+"\nPath: "+path+"\nopId="+opId+"\nobjectName="+objectName); + } + private void process() { + this.toRelations(); + this.fromRelations(); + this.writeRelationsFile(); + + } + private void toRelations() { + logger.debug("{“comment”: “Valid TO Relations that can be added”},"); + logger.debug("apiPath: "+apiPath+"\nopId="+opId+"\nobjectName="+objectName); + Collection toEdges = edgeRuleSet.getEdgeRulesTO(objectName); + + if(toEdges.size() > 0) { + relations.add("{\"comment\": \"Valid TO Relations that can be added\"}\n"); + } + for (EdgeDescription ed : toEdges) { + logger.debug(ed.getRuleKey()+"Type="+ed.getType()); + String obj = ed.getRuleKey().replace(objectName,"").replace("|",""); + String selectedRelation = ""; + if(ed.getType() == EdgeDescription.LineageType.UNRELATED) { + String selectObj = getUnrelatedObjectPaths(obj, apiPath); + logger.debug("SelectedObj:"+selectObj); + selectedRelation = formatObjectRelationSet(obj,selectObj); + logger.debug("ObjectRelationSet"+selectedRelation); + } else { + String selectObj = getKinObjectPath(obj, apiPath); + logger.debug("SelectedObj:"+selectObj); + selectedRelation = formatObjectRelation(obj,selectObj); + logger.debug("ObjectRelationSet"+selectedRelation); + } + relations.add(selectedRelation); + logger.debug("Relation added: "+selectedRelation); + } + } + + private void fromRelations() { + logger.debug("“comment”: “Valid FROM Relations that can be added”"); + Collection fromEdges = edgeRuleSet.getEdgeRulesFROM(objectName); + if(fromEdges.size() > 0) { + relations.add("{\"comment\": \"Valid FROM Relations that can be added\"}\n"); + } + for (EdgeDescription ed : fromEdges) { + logger.debug(ed.getRuleKey()+"Type="+ed.getType()); + String obj = ed.getRuleKey().replace(objectName,"").replace("|",""); + String selectedRelation = ""; + if(ed.getType() == EdgeDescription.LineageType.UNRELATED) { + String selectObj = getUnrelatedObjectPaths(obj, apiPath); + logger.debug("SelectedObj"+selectObj); + selectedRelation = formatObjectRelationSet(obj,selectObj); + logger.trace("ObjectRelationSet"+selectedRelation); + } else { + String selectObj = getKinObjectPath(obj, apiPath); + logger.debug("SelectedObj"+selectObj); + selectedRelation = formatObjectRelation(obj,selectObj); + logger.trace("ObjectRelationSet"+selectedRelation); + } + relations.add(selectedRelation); + logger.trace(selectedRelation); + } + } + private void writeRelationsFile() { + File examplefilePath = new File(GenerateXsd.getYamlDir() + "/relations/" + version.name()+"/"+opId.replace("RelationshipListRelationship", "") + ".json"); + + logger.debug(String.join("exampleFilePath: ", examplefilePath.toString())); + FileOutputStream fop = null; + try { + if (!examplefilePath.exists()) { + examplefilePath.getParentFile().mkdirs(); + examplefilePath.createNewFile(); + } + fop = new FileOutputStream(examplefilePath); + } catch(Exception e) { + e.printStackTrace(); + return; + } + try { + if(relations.size() > 0) {fop.write("[\n".getBytes());} + fop.write(String.join(",\n", relations).getBytes()); + if(relations.size() > 0) {fop.write("\n]\n".getBytes());} + fop.flush(); + fop.close(); + } catch (Exception e) { + e.printStackTrace(); + return; + } + logger.debug(String.join(",\n", relations)); + return; + } + + private static String formatObjectRelationSet(String obj, String selectObj) { + StringBuffer pathSb = new StringBuffer(); + String[] paths = selectObj.split("[|]"); + for (String s: paths) { + logger.trace("SelectOBJ"+s); + pathSb.append(formatObjectRelation(obj, s)+",\n"); + } + pathSb.deleteCharAt(pathSb.length()-2); + return pathSb.toString(); + } + + private static String formatObjectRelation(String obj, String selectObj) { + StringBuffer pathSb = new StringBuffer(); + pathSb.append("{\n"); + pathSb.append("\"related-to\" : \""+obj+"\",\n"); + pathSb.append("\"related-link\" : \""+selectObj+"\"\n"); + pathSb.append("}"); + return pathSb.toString(); + } + + private static String getKinObjectPath(String obj, String apiPath) { + LevenshteinDistance proximity = new LevenshteinDistance(); + String targetPath = ""; + int targetScore = Integer.MAX_VALUE; + int targetMaxScore = 0; + for (Map.Entry p : DeleteOperation.deletePaths.entrySet()) { + if(p.getValue().equals(obj)) { + targetScore = (targetScore >= proximity.apply(apiPath, p.getKey())) ? proximity.apply(apiPath, p.getKey()) : targetScore; + targetPath = (targetScore >= proximity.apply(apiPath, p.getKey())) ? p.getKey() : targetPath; + targetMaxScore = (targetMaxScore <= proximity.apply(apiPath, p.getKey())) ? proximity.apply(apiPath, p.getKey()) : targetScore; + logger.trace(proximity.apply(apiPath, p.getKey())+":"+p.getKey()); + logger.trace(proximity.apply(apiPath, p.getKey())+":"+apiPath); + } + } + return targetPath; + } + + private static String getUnrelatedObjectPaths(String obj, String apiPath) { + String targetPath = ""; + logger.trace("Obj:"+obj +"\n" + apiPath); + for (Map.Entry p : DeleteOperation.deletePaths.entrySet()) { + if(p.getValue().equals(obj)) { + logger.trace("p.getvalue:"+p.getValue()+"p.getkey:"+p.getKey()); + targetPath += ((targetPath.length() == 0 ? "" : "|") + p.getKey()); + logger.trace("Match:"+apiPath +"\n" + targetPath); + } + } + return targetPath; + } + + public void generateRelations(EdgeRuleSet edgeRuleSet) { + + if(putRelationPaths == null) + return; + if(edgeRuleSet == null) + return; + else + PutRelationPathSet.edgeRuleSet = edgeRuleSet; + putRelationPaths.forEach((k,v)->{ + logger.trace("k="+k+"\n"+"v="+v+v.equals("/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship")); + logger.debug("apiPath(Operation): "+v); + logger.debug("Target object: "+v.replace("/relationship-list/relationship", "")); + logger.debug("Relations: "); + PutRelationPathSet prp = new PutRelationPathSet(k, v, this.version); + prp.process(); + }); + } + +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDElement.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDElement.java new file mode 100644 index 00000000..894e7520 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDElement.java @@ -0,0 +1,678 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import com.google.common.base.Joiner; +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.introspection.Version; +import org.w3c.dom.*; + +import java.util.ArrayList; +import java.util.List; +import java.util.StringTokenizer; +import java.util.Vector; + +public class XSDElement implements Element { + Element xmlElementElement; + private static final int VALUE_NONE = 0; + private static final int VALUE_DESCRIPTION = 1; + private static final int VALUE_INDEXED_PROPS = 2; + private static final int VALUE_CONTAINER = 3; + + public XSDElement(Element xmlElementElement) { + super(); + this.xmlElementElement = xmlElementElement; + } + public String name() { + return this.getAttribute("name"); + } + + public Vector getAddTypes(String version) { + String apiVersionFmt = "." + version + "."; + NamedNodeMap attributes = this.getAttributes(); + Vector addTypeV = new Vector(); // vector of 1 + String addType = null; + + for ( int j = 0; j < attributes.getLength(); ++j ) { + Attr attr = (Attr) attributes.item(j); + String attrName = attr.getNodeName(); + + String attrValue = attr.getNodeValue(); + if ( attrName.equals("type")) { + if ( attrValue.contains(apiVersionFmt) ) { + addType = attrValue.substring(attrValue.lastIndexOf('.')+1); + if ( addTypeV == null ) + addTypeV = new Vector(); + addTypeV.add(addType); + } + + } + } + return addTypeV; + } + + public String getPathDescriptionProperty() { + String pathDescriptionProperty = null; + NodeList xmlPropNodes = this.getElementsByTagName("xml-properties"); + + for ( int i = 0; i < xmlPropNodes.getLength(); ++i ) { + Element xmlPropElement = (Element)xmlPropNodes.item(i); + if (! xmlPropElement.getParentNode().getAttributes().getNamedItem("name").getNodeValue().equals(this.xmlElementElement.getAttribute("name"))){ + continue; + } +// This stopped working, replaced with above - should figure out why... +// if ( !xmlPropElement.getParentNode().isSameNode(this.xmlElementElement)) +// continue; + NodeList childNodes = xmlPropElement.getElementsByTagName("xml-property"); + + for ( int j = 0; j < childNodes.getLength(); ++j ) { + Element childElement = (Element)childNodes.item(j); + // get name + int useValue = VALUE_NONE; + NamedNodeMap attributes = childElement.getAttributes(); + for ( int k = 0; k < attributes.getLength(); ++k ) { + Attr attr = (Attr) attributes.item(k); + String attrName = attr.getNodeName(); + String attrValue = attr.getNodeValue(); + if ( attrName == null || attrValue == null ) + continue; + if ( attrName.equals("name") && attrValue.equals("description")) { + useValue = VALUE_DESCRIPTION; + } + if ( useValue == VALUE_DESCRIPTION && attrName.equals("value")) { + pathDescriptionProperty = attrValue; + } + } + } + } + return pathDescriptionProperty; + } + public Vector getIndexedProps() { + Vector indexedProps = new Vector(); + NodeList xmlPropNodes = this.getElementsByTagName("xml-properties"); + + for ( int i = 0; i < xmlPropNodes.getLength(); ++i ) { + Element xmlPropElement = (Element)xmlPropNodes.item(i); + if ( !xmlPropElement.getParentNode().isSameNode(this.xmlElementElement)) + continue; + NodeList childNodes = xmlPropElement.getElementsByTagName("xml-property"); + for ( int j = 0; j < childNodes.getLength(); ++j ) { + Element childElement = (Element)childNodes.item(j); + // get name + int useValue = VALUE_NONE; + NamedNodeMap attributes = childElement.getAttributes(); + for ( int k = 0; k < attributes.getLength(); ++k ) { + Attr attr = (Attr) attributes.item(k); + String attrName = attr.getNodeName(); + String attrValue = attr.getNodeValue(); + if ( attrName == null || attrValue == null ) + continue; + if ( attrValue.equals("indexedProps")) { + useValue = VALUE_INDEXED_PROPS; + } + if ( useValue == VALUE_INDEXED_PROPS && attrName.equals("value")) { + indexedProps = getIndexedProps( attrValue ); + } + } + } + } + return indexedProps; + } + + private static Vector getIndexedProps( String attrValue ) + { + if ( attrValue == null ) + return null; + StringTokenizer st = new StringTokenizer( attrValue, ","); + if ( st.countTokens() == 0 ) + return null; + Vector result = new Vector(); + while ( st.hasMoreTokens()) { + result.add(st.nextToken()); + } + return result; + } + + public String getContainerProperty() { + NodeList xmlPropNodes = this.getElementsByTagName("xml-properties"); + String container = null; + for ( int i = 0; i < xmlPropNodes.getLength(); ++i ) { + Element xmlPropElement = (Element)xmlPropNodes.item(i); + if ( !xmlPropElement.getParentNode().isSameNode(this.xmlElementElement)) + continue; + NodeList childNodes = xmlPropElement.getElementsByTagName("xml-property"); + for ( int j = 0; j < childNodes.getLength(); ++j ) { + Element childElement = (Element)childNodes.item(j); + // get name + int useValue = VALUE_NONE; + NamedNodeMap attributes = childElement.getAttributes(); + for ( int k = 0; k < attributes.getLength(); ++k ) { + Attr attr = (Attr) attributes.item(k); + String attrName = attr.getNodeName(); + String attrValue = attr.getNodeValue(); + if ( attrName == null || attrValue == null ) + continue; + if ( useValue == VALUE_CONTAINER && attrName.equals("value")) { + container = attrValue; + } + if ( attrValue.equals("container")) { + useValue = VALUE_CONTAINER; + } + } + } + } + return container; + } + + public String getQueryParamYAML() { + StringBuffer sbParameter = new StringBuffer(); + sbParameter.append((" - name: " + this.getAttribute("name") + "\n")); + sbParameter.append((" in: query\n")); + if ( this.getAttribute("description") != null && this.getAttribute("description").length() > 0 ) + sbParameter.append((" description: " + this.getAttribute("description") + "\n")); + else + sbParameter.append((" description:\n")); + sbParameter.append((" required: false\n")); + if ( ("java.lang.String").equals(this.getAttribute("type"))) + sbParameter.append(" type: string\n"); + if ( ("java.lang.Long").equals(this.getAttribute("type"))) { + sbParameter.append(" type: integer\n"); + sbParameter.append(" format: int64\n"); + } + if ( ("java.lang.Integer").equals(this.getAttribute("type"))) { + sbParameter.append(" type: integer\n"); + sbParameter.append(" format: int32\n"); + } + if ( ("java.lang.Boolean").equals(this.getAttribute("type"))) { + sbParameter.append(" type: boolean\n"); + } + return sbParameter.toString(); + } + + public String getPathParamYAML(String elementDescription) { + StringBuffer sbParameter = new StringBuffer(); + sbParameter.append((" - name: " + this.getAttribute("name") + "\n")); + sbParameter.append((" in: path\n")); + if ( elementDescription != null && elementDescription.length() > 0 ) + sbParameter.append((" description: " + elementDescription + "\n")); + sbParameter.append((" required: true\n")); + if ( ("java.lang.String").equals(this.getAttribute("type"))) + sbParameter.append(" type: string\n"); + if ( ("java.lang.Long").equals(this.getAttribute("type"))) { + sbParameter.append(" type: integer\n"); + sbParameter.append(" format: int64\n"); + } + if ( ("java.lang.Integer").equals(this.getAttribute("type"))) { + sbParameter.append(" type: integer\n"); + sbParameter.append(" format: int32\n"); + } + if ( ("java.lang.Boolean").equals(this.getAttribute("type"))) { + sbParameter.append(" type: boolean\n"); + } + if(StringUtils.isNotBlank(this.getAttribute("name"))) { + sbParameter.append(" example: "+"__"+this.getAttribute("name").toUpperCase()+"__"+"\n"); + } + return sbParameter.toString(); + } + + public String getHTMLElement(Version v, boolean useAnnotation, HTMLfromOXM driver) { + StringBuffer sbElement = new StringBuffer(); + String elementName = this.getAttribute("name"); + String elementType = this.getAttribute("type"); + String elementContainerType = this.getAttribute("container-type"); + String elementIsRequired = this.getAttribute("required"); + String addType = elementType.contains("." + v.name() + ".") ? elementType.substring(elementType.lastIndexOf('.')+1) : null; + + if ( addType != null ) { + sbElement.append(" \n" : ""); + sbElement.append(annotation); + sbElement.append(StringUtils.isNotEmpty(annotation) ? " \n" : "/>\n" ); + } else { + sbElement.append("/>\n"); + } + return this.getHTMLElementWrapper(sbElement.toString(), v, useAnnotation); +// return sbElement.toString(); + } + + public String getHTMLElementWrapper(String unwrappedElement, Version v, boolean useAnnotation) { + + NodeList childNodes = this.getElementsByTagName("xml-element-wrapper"); + + String xmlElementWrapper = null; + if ( childNodes.getLength() > 0 ) { + Element childElement = (Element)childNodes.item(0); + // get name + xmlElementWrapper = childElement == null ? null : childElement.getAttribute("name"); + } + if(xmlElementWrapper == null) + return unwrappedElement; + + StringBuffer sbElement = new StringBuffer(); + sbElement.append(" \n"); + sbElement.append(" \n"); + if(useAnnotation) { + XSDElement javaTypeElement = new XSDElement((Element)this.getParentNode()); + sbElement.append(javaTypeElement.getHTMLAnnotation("class", " ")); + } + sbElement.append(" \n"); + sbElement.append(" "); + sbElement.append(unwrappedElement); + sbElement.append(" \n"); + sbElement.append(" \n"); + sbElement.append(" \n"); + return sbElement.toString(); + } + + public String getHTMLAnnotation(String target, String indentation) { + StringBuffer sb = new StringBuffer(); + List metadata = new ArrayList<>(); + if("true".equals(this.getAttribute("xml-key")) ) { + metadata.add("isKey=true"); + } + + NodeList xmlPropTags = this.getElementsByTagName("xml-properties"); + Element xmlPropElement = null; + for ( int i = 0; i < xmlPropTags.getLength(); ++i ) { + xmlPropElement = (Element)xmlPropTags.item(i); + if (! xmlPropElement.getParentNode().getAttributes().getNamedItem("name").getNodeValue().equals(this.xmlElementElement.getAttribute("name"))) + continue; + else + break; + } + if(xmlPropElement != null) { + NodeList xmlProperties = xmlPropElement.getElementsByTagName("xml-property"); + for (int i = 0; i < xmlProperties.getLength(); i++) { + Element item = (Element)xmlProperties.item(i); + String name = item.getAttribute("name"); + String value = item.getAttribute("value"); + if (name.equals("abstract")) { + name = "isAbstract"; + } else if (name.equals("extends")) { + name = "extendsFrom"; + } + metadata.add(name + "=\"" + value.replaceAll("&", "&") + "\""); + } + } + if(metadata.size() == 0) { + return ""; + } + sb.append(indentation +"\r\n"); + sb.append( + indentation + " \r\n" + + indentation + " @org.onap.aai.annotations.Metadata(" + Joiner.on(",").join(metadata) + ")\r\n" + + indentation + " \r\n"); + sb.append(indentation +"\r\n"); + return sb.toString(); + } + + public String getTypePropertyYAML() { + StringBuffer sbProperties = new StringBuffer(); + sbProperties.append(" " + this.getAttribute("name") + ":\n"); + sbProperties.append(" type: "); + + if ( ("java.lang.String").equals(this.getAttribute("type"))) + sbProperties.append("string\n"); + else if ( ("java.lang.Long").equals(this.getAttribute("type"))) { + sbProperties.append("integer\n"); + sbProperties.append(" format: int64\n"); + } + else if ( ("java.lang.Integer").equals(this.getAttribute("type"))){ + sbProperties.append("integer\n"); + sbProperties.append(" format: int32\n"); + } + else if ( ("java.lang.Boolean").equals(this.getAttribute("type"))) + sbProperties.append("boolean\n"); + String attrDescription = this.getPathDescriptionProperty(); + if ( attrDescription != null && attrDescription.length() > 0 ) + sbProperties.append(" description: " + attrDescription + "\n"); + return sbProperties.toString(); + } + + public boolean isStandardType() + { + switch ( this.getAttribute("type") ) { + case "java.lang.String": + case "java.lang.Long": + case "java.lang.Integer": + case"java.lang.Boolean": + return true; + } + return false; + } + + @Override + public String getNodeName() { + return xmlElementElement.getNodeName(); + } + + @Override + public String getNodeValue() throws DOMException { + return xmlElementElement.getNodeValue(); + } + + @Override + public void setNodeValue(String nodeValue) throws DOMException { + xmlElementElement.setNodeValue(nodeValue); + } + + @Override + public short getNodeType() { + return xmlElementElement.getNodeType(); + } + + @Override + public Node getParentNode() { + return xmlElementElement.getParentNode(); + } + + @Override + public NodeList getChildNodes() { + return xmlElementElement.getChildNodes(); + } + + @Override + public Node getFirstChild() { + return xmlElementElement.getFirstChild(); + } + + @Override + public Node getLastChild() { + return xmlElementElement.getLastChild(); + } + + @Override + public Node getPreviousSibling() { + return xmlElementElement.getPreviousSibling(); + } + + @Override + public Node getNextSibling() { + return xmlElementElement.getNextSibling(); + } + + @Override + public NamedNodeMap getAttributes() { + return xmlElementElement.getAttributes(); + } + + @Override + public Document getOwnerDocument() { + return xmlElementElement.getOwnerDocument(); + } + + @Override + public Node insertBefore(Node newChild, Node refChild) throws DOMException { + return xmlElementElement.insertBefore(newChild, refChild); + } + + @Override + public Node replaceChild(Node newChild, Node oldChild) throws DOMException { + return xmlElementElement.replaceChild(newChild, oldChild); + } + + @Override + public Node removeChild(Node oldChild) throws DOMException { + return xmlElementElement.removeChild(oldChild); + } + + @Override + public Node appendChild(Node newChild) throws DOMException { + return xmlElementElement.appendChild(newChild); + } + + @Override + public boolean hasChildNodes() { + return xmlElementElement.hasChildNodes(); + } + + @Override + public Node cloneNode(boolean deep) { + return xmlElementElement.cloneNode(deep); + } + + @Override + public void normalize() { + xmlElementElement.normalize(); + } + + @Override + public boolean isSupported(String feature, String version) { + return xmlElementElement.isSupported(feature, version); + } + + @Override + public String getNamespaceURI() { + return xmlElementElement.getNamespaceURI(); + } + + @Override + public String getPrefix() { + return xmlElementElement.getPrefix(); + } + + @Override + public void setPrefix(String prefix) throws DOMException { + xmlElementElement.setPrefix(prefix); + } + + @Override + public String getLocalName() { + + return xmlElementElement.getLocalName(); + } + + @Override + public boolean hasAttributes() { + return xmlElementElement.hasAttributes(); + } + + @Override + public String getBaseURI() { + return xmlElementElement.getBaseURI(); + } + + @Override + public short compareDocumentPosition(Node other) throws DOMException { + return xmlElementElement.compareDocumentPosition(other); + } + + @Override + public String getTextContent() throws DOMException { + return xmlElementElement.getTextContent(); + } + + @Override + public void setTextContent(String textContent) throws DOMException { + xmlElementElement.setTextContent(textContent); + } + + @Override + public boolean isSameNode(Node other) { + return xmlElementElement.isSameNode(other); + } + + @Override + public String lookupPrefix(String namespaceURI) { + return xmlElementElement.lookupPrefix(namespaceURI); + } + + @Override + public boolean isDefaultNamespace(String namespaceURI) { + return xmlElementElement.isDefaultNamespace(namespaceURI); + } + + @Override + public String lookupNamespaceURI(String prefix) { + return xmlElementElement.lookupNamespaceURI(prefix); + } + + @Override + public boolean isEqualNode(Node arg) { + return xmlElementElement.isEqualNode(arg); + } + + @Override + public Object getFeature(String feature, String version) { + return xmlElementElement.getFeature(feature, version); + } + + @Override + public Object setUserData(String key, Object data, UserDataHandler handler) { + return xmlElementElement.setUserData(key, data, handler); + } + + @Override + public Object getUserData(String key) { + return xmlElementElement.getUserData(key); + } + + @Override + public String getTagName() { + return xmlElementElement.getTagName(); + } + + @Override + public String getAttribute(String name) { + return xmlElementElement.getAttribute(name); + } + + @Override + public void setAttribute(String name, String value) throws DOMException { + xmlElementElement.setAttribute(name, value); + } + + @Override + public void removeAttribute(String name) throws DOMException { + xmlElementElement.removeAttribute(name); + } + + @Override + public Attr getAttributeNode(String name) { + return xmlElementElement.getAttributeNode(name); + } + + @Override + public Attr setAttributeNode(Attr newAttr) throws DOMException { + return xmlElementElement.setAttributeNode(newAttr); + } + + @Override + public Attr removeAttributeNode(Attr oldAttr) throws DOMException { + return xmlElementElement.removeAttributeNode(oldAttr); + } + + @Override + public NodeList getElementsByTagName(String name) { + return xmlElementElement.getElementsByTagName(name); + } + + @Override + public String getAttributeNS(String namespaceURI, String localName) throws DOMException { + return xmlElementElement.getAttributeNS(namespaceURI, localName); + } + + @Override + public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException { + xmlElementElement.setAttributeNS(namespaceURI, qualifiedName, value); + return; + } + + @Override + public void removeAttributeNS(String namespaceURI, String localName) throws DOMException { + xmlElementElement.removeAttributeNS(namespaceURI, localName); + } + + @Override + public Attr getAttributeNodeNS(String namespaceURI, String localName) throws DOMException { + return xmlElementElement.getAttributeNodeNS(namespaceURI, localName); + } + + @Override + public Attr setAttributeNodeNS(Attr newAttr) throws DOMException { + return xmlElementElement.setAttributeNodeNS(newAttr); + } + + @Override + public NodeList getElementsByTagNameNS(String namespaceURI, String localName) throws DOMException { + return xmlElementElement.getElementsByTagNameNS(namespaceURI, localName); + } + + @Override + public boolean hasAttribute(String name) { + return xmlElementElement.hasAttribute(name); + } + + @Override + public boolean hasAttributeNS(String namespaceURI, String localName) throws DOMException { + return xmlElementElement.hasAttributeNS(namespaceURI, localName); + } + + @Override + public TypeInfo getSchemaTypeInfo() { + return xmlElementElement.getSchemaTypeInfo(); + } + + @Override + public void setIdAttribute(String name, boolean isId) throws DOMException { + xmlElementElement.setIdAttribute(name, isId); + + } + + @Override + public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException { + xmlElementElement.setIdAttributeNS(namespaceURI, localName, isId); + } + + @Override + public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException { + xmlElementElement.setIdAttributeNode(idAttr, isId); + return; + } + + +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDJavaType.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDJavaType.java new file mode 100644 index 00000000..6315ddff --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/XSDJavaType.java @@ -0,0 +1,64 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; + +public class XSDJavaType extends XSDElement { + StringBuffer pathSb; + StringBuffer definitionsSb; + StringBuffer pathParams; + + public XSDJavaType(Element javaTypeElement) { + super(javaTypeElement); + } +/* + public XSDJavaType(XSDElement javaTypeElement, StringBuffer pathSb, StringBuffer definitionsSb, + StringBuffer pathParams) { + super(javaTypeElement); + this.pathSb = pathSb; + this.definitionsSb = definitionsSb; + this.pathParams = pathParams; + } +*/ + public String getItemName() { + NodeList parentNodes = this.getElementsByTagName("java-attributes"); + if(parentNodes.getLength() == 0) + return null; + Element parentElement = (Element)parentNodes.item(0); + NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); + XSDElement xmlElementElement = new XSDElement((Element)xmlElementNodes.item(0)); + return xmlElementElement.getAttribute("name"); + } + + public String getArrayType() { + NodeList parentNodes = this.getElementsByTagName("java-attributes"); + if(parentNodes.getLength() == 0) + return null; + Element parentElement = (Element)parentNodes.item(0); + NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); + XSDElement xmlElementElement = new XSDElement((Element)xmlElementNodes.item(0)); + if ( xmlElementElement.hasAttribute("container-type") && xmlElementElement.getAttribute("container-type").equals("java.util.ArrayList")) { + return xmlElementElement.getAttribute("name"); + } + return null; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/util/genxsd/YAMLfromOXM.java b/aai-core/src/main/java/org/onap/aai/util/genxsd/YAMLfromOXM.java new file mode 100644 index 00000000..ff7d44b6 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/genxsd/YAMLfromOXM.java @@ -0,0 +1,470 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang3.StringUtils; +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.Version; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; + +import javax.xml.parsers.ParserConfigurationException; +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.*; + +public class YAMLfromOXM extends OxmFileProcessor { + private static final Logger logger = LoggerFactory.getLogger("GenerateXsd.class"); + private static final String root = "../aai-schema/src/main/resources"; + private static final String autoGenRoot = "aai-schema/src/main/resources"; + private static final String generateTypeYAML = "yaml"; + private static final String normalStartDir = "aai-core"; + private static final String yaml_dir = (((System.getProperty("user.dir") != null) && (!System.getProperty("user.dir").contains(normalStartDir))) ? autoGenRoot : root) + "/aai_swagger_yaml"; + + private File edgeFile; + private EdgeRuleSet edgeRuleSet = null; + public YAMLfromOXM(File oxmFile, Version v, File edgeFile) throws ParserConfigurationException, SAXException, IOException, AAIException, FileNotFoundException { + super(oxmFile, v); + this.edgeFile = edgeFile; + init(); + } + public YAMLfromOXM(String xml, Version v, File edgeFile) throws ParserConfigurationException, SAXException, IOException, AAIException, FileNotFoundException { + super(xml, v); + this.edgeFile = edgeFile; + init(); + } + + @Override + public String getDocumentHeader() { + StringBuffer sb = new StringBuffer(); + sb.append("swagger: \"2.0\"\ninfo:\n "); + sb.append("description: |"); + sb.append("\n\n [Differences versus the previous schema version]("+"apidocs/aai_swagger_" + v.name() + ".diff)"); + sb.append("\n\n Copyright © 2017 AT&T Intellectual Property. All rights reserved.\n\n Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.\n\n You may obtain a copy of the License at\n\n (https://creativecommons.org/licenses/by/4.0/)\n\n Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\n ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.\n\n This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.\n version: \"" + v.name() +"\"\n"); + sb.append(" title: Active and Available Inventory REST API\n"); + sb.append(" license:\n name: Apache 2.0\n url: http://www.apache.org/licenses/LICENSE-2.0.html\n"); + sb.append(" contact:\n name:\n url:\n email:\n"); + sb.append("host:\nbasePath: /aai/" + v.name() + "\n"); + sb.append("schemes:\n - https\npaths:\n"); + return sb.toString(); + } + + protected void init() throws ParserConfigurationException, SAXException, IOException, AAIException, FileNotFoundException { + super.init(); + edgeRuleSet = new EdgeRuleSet(edgeFile); + } + + @Override + public String process() throws AAIException { + StringBuffer sb = new StringBuffer(); + EdgeRuleSet edgeRuleSet = null; + try { + edgeRuleSet = new EdgeRuleSet(edgeFile); + } catch (Exception e) { + logger.warn("No valid Edge Rule Set available("+edgeFile+"): "+e.getMessage()); + } + + StringBuffer pathSb = new StringBuffer(); + pathSb.append(getDocumentHeader()); + StringBuffer definitionsSb = new StringBuffer(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element)javaTypeNodes.item(i)); + logger.debug("External: "+javaTypeElement.getAttribute("name")); + String javaTypeName = javaTypeElement.name(); + if ( javaTypeName == null ) { + String msg = "Invalid OXM file: has no name attribute in " + oxmFile; + logger.error(msg); + throw new AAIException(msg); + } + //Skip any type that has already been processed(recursion could be the reason) + if ( generatedJavaType.containsKey(getXmlRootElementName(javaTypeName)) ) { + continue; + } + processJavaTypeElementSwagger( javaTypeName, javaTypeElement, pathSb, + definitionsSb, null, null, null, null, null, null); + } + sb.append(pathSb); + + sb.append(appendDefinitions()); + PutRelationPathSet prp = new PutRelationPathSet(v); + prp.generateRelations(edgeRuleSet); + return sb.toString(); + } + + public String appendDefinitions() { + //append definitions + StringBuffer sb = new StringBuffer("definitions:\n"); + Map sortedJavaTypeDefinitions = new TreeMap(javaTypeDefinitions); + for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { + logger.debug("Key: "+entry.getKey()+"Test: "+ (entry.getKey() == "relationship")); + if(entry.getKey().matches("relationship")) { + String jb=entry.getValue(); + logger.debug("Value: "+jb); + int ndx=jb.indexOf("related-to-property:"); + if(ndx > 0) { + jb=jb.substring(0, ndx); + jb=jb.replaceAll(" +$", ""); + } + logger.debug("Value-after: "+jb); + sb.append(jb); + continue; + } + sb.append(entry.getValue()); + } + + sb.append("patchDefinitions:\n"); + for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { + String jb=entry.getValue().replaceAll("/definitions/", "/patchDefinitions/"); + int ndx=jb.indexOf("relationship-list:"); + if(ndx > 0) { + jb=jb.substring(0, ndx); + jb=jb.replaceAll(" +$", ""); + } + int ndx1=jb.indexOf("resource-version:"); + logger.debug("Key: "+entry.getKey()+" index: " + ndx1); + logger.debug("Value: "+jb); + if(ndx1 > 0) { + jb=jb.substring(0, ndx1); + jb=jb.replaceAll(" +$", ""); + } + logger.debug("Value-after: "+jb); + sb.append(jb); + } + + sb.append("getDefinitions:\n"); + for (Map.Entry entry : sortedJavaTypeDefinitions.entrySet()) { + String jb=entry.getValue().replaceAll("/definitions/", "/getDefinitions/"); + sb.append(jb); + } + return sb.toString(); + } + + private String processJavaTypeElementSwagger( String javaTypeName, Element javaTypeElement, + StringBuffer pathSb, StringBuffer definitionsSb, String path, String tag, String opId, + String getItemName, StringBuffer pathParams, String validEdges) { + + String xmlRootElementName = getXMLRootElementName(javaTypeElement); + StringBuilder definitionsLocalSb = new StringBuilder(256); + + String useTag = null; + String useOpId = null; + logger.debug("tag="+tag); + if ( tag != null ) { + switch ( tag ) { + case "Network": + case "ServiceDesignAndCreation": + case "Business": + case "LicenseManagement": + case "CloudInfrastructure": + break; + default: + logger.debug("javaTypeName="+javaTypeName); + return null; + } + } + + if ( !javaTypeName.equals("Inventory") ) { + if ( javaTypeName.equals("AaiInternal")) + return null; + if ( opId == null ) + useOpId = javaTypeName; + else + useOpId = opId + javaTypeName; + if ( tag == null ) + useTag = javaTypeName; + } + + path = xmlRootElementName.equals("inventory") ? "" : (path == null) ? "/" + xmlRootElementName : path + "/" + xmlRootElementName; + XSDJavaType javaType = new XSDJavaType(javaTypeElement); + if ( getItemName != null) { + if ( getItemName.equals("array") ) + return javaType.getArrayType(); + else + return javaType.getItemName(); + } + + NodeList parentNodes = javaTypeElement.getElementsByTagName("java-attributes"); + if ( parentNodes.getLength() == 0 ) { + logger.debug( "no java-attributes for java-type " + javaTypeName); + return ""; + } + + String pathDescriptionProperty = javaType.getPathDescriptionProperty(); + String container = javaType.getContainerProperty(); + Vector indexedProps = javaType.getIndexedProps(); + Vector containerProps = new Vector(); + if(container != null) { + logger.debug("javaTypeName " + javaTypeName + " container:" + container +" indexedProps:"+indexedProps); + } + + Element parentElement = (Element)parentNodes.item(0); + NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); + + StringBuffer sbParameters = new StringBuffer(); + StringBuffer sbRequired = new StringBuffer(); + int requiredCnt = 0; + int propertyCnt = 0; + StringBuffer sbProperties = new StringBuffer(); + + if ( appliedPaths.containsKey(path)) + return null; + + StringTokenizer st = new StringTokenizer(path, "/"); + logger.debug("path: " + path + " st? " + st.toString()); + if ( st.countTokens() > 1 && getItemName == null ) { + logger.debug("appliedPaths: " + appliedPaths + " containsKey? " + appliedPaths.containsKey(path)); + appliedPaths.put(path, xmlRootElementName); + } + + Vector addTypeV = null; + for ( int i = 0; i < xmlElementNodes.getLength(); ++i ) { + XSDElement xmlElementElement = new XSDElement((Element)xmlElementNodes.item(i)); + if ( !xmlElementElement.getParentNode().isSameNode(parentElement)) + continue; + String elementDescription=xmlElementElement.getPathDescriptionProperty(); + if(getItemName == null) { + addTypeV = xmlElementElement.getAddTypes(v.name()); + } + if ( "true".equals(xmlElementElement.getAttribute("xml-key"))) { + path += "/{" + xmlElementElement.getAttribute("name") + "}"; + } + logger.debug("path: " + path); + logger.debug( "xmlElementElement.getAttribute(required):"+xmlElementElement.getAttribute("required") ); + + if ( ("true").equals(xmlElementElement.getAttribute("required"))) { + if ( requiredCnt == 0 ) + sbRequired.append(" required:\n"); + ++requiredCnt; + if ( addTypeV == null || addTypeV.isEmpty()) { + sbRequired.append(" - " + xmlElementElement.getAttribute("name") + "\n"); + } else { + for ( int k = 0; k < addTypeV.size(); ++k ) { + sbRequired.append(" - " + getXmlRootElementName(addTypeV.elementAt(k)) + ":\n"); + } + } + } + + if ( "true".equals(xmlElementElement.getAttribute("xml-key")) ) { + sbParameters.append(xmlElementElement.getPathParamYAML(elementDescription)); + } + if ( indexedProps != null + && indexedProps.contains(xmlElementElement.getAttribute("name") ) ) { + containerProps.add(xmlElementElement.getQueryParamYAML()); + GetOperation.addContainerProps(container, containerProps); + } + if ( xmlElementElement.isStandardType()) { + sbProperties.append(xmlElementElement.getTypePropertyYAML()); + ++propertyCnt; + } + + StringBuffer newPathParams = new StringBuffer((pathParams == null ? "" : pathParams.toString())+sbParameters.toString()); + for ( int k = 0; addTypeV != null && k < addTypeV.size(); ++k ) { + String addType = addTypeV.elementAt(k); + logger.debug("addType: "+ addType); + if(addType == "overloaded-model" || addType.equals("OverloadedModel") || addType == "owning-entity") { + logger.debug("Description check: "+ addType+"opId="+opId+" itemName=none"); +// Log.info("Element name="+xmlElementElement.getAttribute("name")); + } + + + if ( opId == null || !opId.contains(addType)) { + processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), + pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, null, + newPathParams, validEdges); + } + // need item name of array + String itemName = processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), + pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, + "array", null, null ); + + if ( itemName != null ) { + if ( addType.equals("AaiInternal") ) { + logger.debug( "addType AaiInternal, skip properties"); + + } else if ( getItemName == null) { + ++propertyCnt; + sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); + sbProperties.append(" type: array\n items:\n"); + sbProperties.append(" $ref: \"#/definitions/" + (itemName == "" ? "aai-internal" : itemName) + "\"\n"); + if ( StringUtils.isNotEmpty(elementDescription) ) + sbProperties.append(" description: " + elementDescription + "\n"); + } + } else { + if ( ("java.util.ArrayList").equals(xmlElementElement.getAttribute("container-type"))) { + // need properties for getXmlRootElementName(addType) + newPathParams = new StringBuffer((pathParams == null ? "" : pathParams.toString())+sbParameters.toString()); + processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), + pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, + null, newPathParams, validEdges ); + sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); + sbProperties.append(" type: array\n items: \n"); + sbProperties.append(" $ref: \"#/definitions/" + getXmlRootElementName(addType) + "\"\n"); + if ( StringUtils.isNotEmpty(elementDescription) ) + sbProperties.append(" description: " + elementDescription + "\n"); + + } else { + if(addType.equals("AaiInternal")) //Filter out references to AaiInternal + sbProperties.append(""); + else { + sbProperties.append(" " + getXmlRootElementName(addType) + ":\n"); + sbProperties.append(" type: object\n"); + sbProperties.append(" $ref: \"#/definitions/" + getXmlRootElementName(addType) + "\"\n"); + } + } + if ( StringUtils.isNotEmpty(elementDescription) ) + sbProperties.append(" description: " + elementDescription + "\n"); + ++propertyCnt; + } + } + } + + if ( sbParameters.toString().length() > 0 ) { + if ( pathParams == null ) + pathParams = new StringBuffer(); + pathParams.append(sbParameters); + } + GetOperation get = new GetOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); + pathSb.append(get.toString()); + logger.debug("opId vs useOpId:"+opId+" vs "+useOpId+" PathParams="+pathParams); + // add PUT + PutOperation put = new PutOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString(), this.v); + pathSb.append(put.toString()); + // add PATCH + PatchOperation patch = new PatchOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); + pathSb.append(patch.toString()); + // add DELETE + DeleteOperation del = new DeleteOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); + pathSb.append(del.toString()); + //Write operations by Namespace(tagName) +// if(javaTypeName == useTag && tag == null) { +// pathSb.append(appendDefinitions()); +// writeYAMLfile(javaTypeName, pathSb.toString()); +// pathSb.delete(0, pathSb.length()); +// javaTypeDefinitions.clear(); +// generatedJavaType.clear(); +// } + if ( generatedJavaType.containsKey(xmlRootElementName) ) { + logger.debug("xmlRootElementName(1)="+xmlRootElementName); + return null; + } + + definitionsSb.append(" " + xmlRootElementName + ":\n"); + definitionsLocalSb.append(" " + xmlRootElementName + ":\n"); + Collection edges = edgeRuleSet.getEdgeRules(xmlRootElementName ); + DeleteFootnoteSet footnotes = new DeleteFootnoteSet(xmlRootElementName); + if ( edges.size() > 0 ) { + StringBuffer sbEdge = new StringBuffer(); + sbEdge.append(" ###### Related Nodes\n"); + + for (EdgeDescription ed : edges) { + if ( ed.getRuleKey().startsWith(xmlRootElementName)) { + sbEdge.append(" - TO ").append(ed.getRuleKey().substring(ed.getRuleKey().indexOf("|")+1)); + String footnote = ed.getAlsoDeleteFootnote(xmlRootElementName); + sbEdge.append(ed.getRelationshipDescription("TO", xmlRootElementName)+footnote+"\n"); + if(StringUtils.isNotEmpty(footnote)) footnotes.add(footnote); + } + } + for (EdgeDescription ed : edges) { + if ( ed.getRuleKey().endsWith(xmlRootElementName)) { + sbEdge.append(" - FROM ").append(ed.getRuleKey().substring(0, ed.getRuleKey().indexOf("|"))); + String footnote = ed.getAlsoDeleteFootnote(xmlRootElementName); + sbEdge.append(ed.getRelationshipDescription("FROM", xmlRootElementName)+footnote+"\n"); + if(StringUtils.isNotEmpty(footnote)) footnotes.add(footnote); + } + } + footnotes.add(edgeRuleSet.preventDeleteRules(xmlRootElementName)); + sbEdge.append(footnotes.toString()); + validEdges = sbEdge.toString(); + } + + // Handle description property. Might have a description OR valid edges OR both OR neither. + // Only put a description: tag if there is at least one. + if (pathDescriptionProperty != null || validEdges != null) { + definitionsSb.append(" description: |\n"); + definitionsLocalSb.append(" description: |\n"); + + if ( pathDescriptionProperty != null ) { + definitionsSb.append(" " + pathDescriptionProperty + "\n" ); + definitionsLocalSb.append(" " + pathDescriptionProperty + "\n" ); + } + if (validEdges != null) { + definitionsSb.append(validEdges); + definitionsLocalSb.append(validEdges); + } + } + + if ( requiredCnt > 0 ) { + definitionsSb.append(sbRequired); + definitionsLocalSb.append(sbRequired); + } + + if ( propertyCnt > 0 ) { + definitionsSb.append(" properties:\n"); + definitionsSb.append(sbProperties); + definitionsLocalSb.append(" properties:\n"); + definitionsLocalSb.append(sbProperties); + } + try { + javaTypeDefinitions.put(xmlRootElementName, definitionsLocalSb.toString()); + } catch (Exception e) { + e.printStackTrace(); + } + generatedJavaType.put(xmlRootElementName, null); + logger.trace("xmlRootElementName(2)="+xmlRootElementName); + return null; + } + + private void writeYAMLfile(String outfileName, String fileContent) { + outfileName = (StringUtils.isEmpty(outfileName)) ? "aai_swagger" : outfileName; + outfileName = (outfileName.lastIndexOf(File.separator) == -1) ? yaml_dir + File.separator +outfileName+"_" + v.name() + "." + generateTypeYAML : outfileName; + File outfile = new File(outfileName); + File parentDir = outfile.getParentFile(); + if(parentDir != null && ! parentDir.exists()) + parentDir.mkdirs(); + try { + outfile.createNewFile(); + } catch (IOException e) { + logger.error( "Exception creating output file " + outfileName); + e.printStackTrace(); + } + BufferedWriter bw = null; + try { + Charset charset = Charset.forName("UTF-8"); + Path path = Paths.get(outfileName); + bw = Files.newBufferedWriter(path, charset); + bw.write(fileContent); + if ( bw != null ) { + bw.close(); + } + } catch ( IOException e) { + logger.error( "Exception writing output file " + outfileName); + e.printStackTrace(); + } + } +} diff --git a/aai-core/src/test/java/org/onap/aai/AAIJunitRunner.java b/aai-core/src/test/java/org/onap/aai/AAIJunitRunner.java index 41a2f424..94fce5d4 100644 --- a/aai-core/src/test/java/org/onap/aai/AAIJunitRunner.java +++ b/aai-core/src/test/java/org/onap/aai/AAIJunitRunner.java @@ -19,16 +19,15 @@ */ package org.onap.aai; -import org.junit.runners.BlockJUnit4ClassRunner; -import org.junit.runners.model.InitializationError; +import org.junit.runners.Parameterized; import org.onap.aai.util.AAIConstants; import java.lang.reflect.Field; import java.lang.reflect.Modifier; -public class AAIJunitRunner extends BlockJUnit4ClassRunner { +public class AAIJunitRunner extends Parameterized { - public AAIJunitRunner(Class klass) throws InitializationError { + public AAIJunitRunner(Class klass) throws Throwable { super(klass); setProps(); modifyOxmHome(); diff --git a/aai-core/src/test/java/org/onap/aai/HttpTestUtil.java b/aai-core/src/test/java/org/onap/aai/HttpTestUtil.java index 7284593e..943ebad5 100644 --- a/aai-core/src/test/java/org/onap/aai/HttpTestUtil.java +++ b/aai-core/src/test/java/org/onap/aai/HttpTestUtil.java @@ -41,7 +41,9 @@ import org.onap.aai.serialization.engines.TransactionalGraphEngine; import javax.ws.rs.core.*; import java.io.UnsupportedEncodingException; import java.net.URI; -import java.util.*; +import java.util.ArrayList; +import java.util.List; +import java.util.UUID; import static org.mockito.Matchers.anyObject; import static org.mockito.Mockito.doReturn; @@ -54,6 +56,7 @@ public class HttpTestUtil extends RESTAPI { protected static final MediaType APPLICATION_JSON = MediaType.valueOf("application/json"); private static final String EMPTY = ""; + private final QueryStyle queryStyle; protected HttpHeaders httpHeaders; protected UriInfo uriInfo; @@ -64,6 +67,10 @@ public class HttpTestUtil extends RESTAPI { protected List aaiRequestContextList; protected List outputMediaTypes; + public HttpTestUtil(QueryStyle qs) { + this.queryStyle = qs; + } + public void init(){ httpHeaders = Mockito.mock(HttpHeaders.class); @@ -114,7 +121,7 @@ public class HttpTestUtil extends RESTAPI { if(arr != null && arr.length > 1){ if(arr[0].matches("^v\\d+")){ - version = Version.valueOf(arr[0]); + version = Version.getVersion(arr[0]); uri = uri.replaceAll("^v\\d+", ""); } } @@ -125,7 +132,7 @@ public class HttpTestUtil extends RESTAPI { Mockito.when(uriInfo.getPath()).thenReturn(uri); DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); dbEngine = httpEntry.getDbEngine(); @@ -206,7 +213,7 @@ public class HttpTestUtil extends RESTAPI { if(arr != null && arr.length > 1){ if(arr[0].matches("^v\\d+")){ - version = Version.valueOf(arr[0]); + version = Version.getVersion(arr[0]); uri = uri.replaceAll("^v\\d+", ""); } } @@ -216,7 +223,7 @@ public class HttpTestUtil extends RESTAPI { } DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); dbEngine = httpEntry.getDbEngine(); @@ -287,7 +294,7 @@ public class HttpTestUtil extends RESTAPI { if(arr != null && arr.length > 1){ if(arr[0].matches("^v\\d+")){ - version = Version.valueOf(arr[0]); + version = Version.getVersion(arr[0]); if(!uri.contains("relationship-list/relationship")){ uri = uri.replaceAll("^v\\d+", ""); } @@ -300,7 +307,7 @@ public class HttpTestUtil extends RESTAPI { Mockito.when(uriInfo.getPath()).thenReturn(uri); DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(version, ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); dbEngine = httpEntry.getDbEngine(); diff --git a/aai-core/src/test/java/org/onap/aai/introspection/MoxyLoaderTest.java b/aai-core/src/test/java/org/onap/aai/introspection/MoxyLoaderTest.java new file mode 100644 index 00000000..95a4bb61 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/MoxyLoaderTest.java @@ -0,0 +1,77 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection; + +import org.junit.Test; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.restcore.MediaType; + +import static org.junit.Assert.assertEquals; + +public class MoxyLoaderTest extends IntrospectorTestSpec { + + /** + * Container object. + * @throws AAIUnknownObjectException + */ + @Test + public void testMethodsForExceptions() throws AAIUnknownObjectException { + + MoxyLoader loader = (MoxyLoader) LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v9); + String payload = "{\"att-uuid\":\"wr148d\",\"application\":\"testApp\",\"application-vendor\":\"testVendor\",\"application-version\":\"versionTest\"}"; + Boolean exceptionThrownForIntrospector = false; + Boolean exceptionThrownForLoaderMethods = false; + Boolean exceptionThrownForUnmarshalling = false; + Boolean exceptionThrownForObjectFromName = false; + try { + loader.getAllObjects(); + loader.getJAXBContext(); + }catch(Exception e){ + exceptionThrownForLoaderMethods = true; + } + try{ + loader.introspectorFromName("TEST"); + }catch(Exception e){ + exceptionThrownForIntrospector = true; + } + try { + loader.unmarshal("vnf-image", payload, MediaType.APPLICATION_JSON_TYPE); + loader.unmarshal("vnf-image", null, MediaType.APPLICATION_JSON_TYPE); + loader.unmarshal("vnf-image", "{}", MediaType.APPLICATION_JSON_TYPE); + }catch(Exception e){ + exceptionThrownForUnmarshalling = true; + } + try{ + loader.objectFromName(null); + loader.objectFromName("test"); + }catch(Exception e) { + exceptionThrownForObjectFromName = true; + } + + assertEquals(false, exceptionThrownForLoaderMethods); + assertEquals(true, exceptionThrownForIntrospector); + assertEquals(true, exceptionThrownForUnmarshalling); + assertEquals(true, exceptionThrownForObjectFromName); + + } + + + +} diff --git a/aai-core/src/test/java/org/onap/aai/introspection/PojoStrategyTest.java b/aai-core/src/test/java/org/onap/aai/introspection/PojoStrategyTest.java index d30b51b0..1c68d087 100644 --- a/aai-core/src/test/java/org/onap/aai/introspection/PojoStrategyTest.java +++ b/aai-core/src/test/java/org/onap/aai/introspection/PojoStrategyTest.java @@ -39,4 +39,69 @@ public class PojoStrategyTest { assertEquals("", volumegroup.getMetadata(ObjectMetadata.NAMESPACE)); } + @Test + public void testGetWithBogusValue(){ + Introspector cloudregion = IntrospectorFactory.newInstance(ModelType.POJO, new CloudRegion()); + assertEquals(null, cloudregion.get("test")); + } + + @Test + public void testSetWithValue(){ + Introspector cloudregion = IntrospectorFactory.newInstance(ModelType.POJO, new CloudRegion()); + cloudregion.set("cloudOwner", "test"); + assertEquals("test", cloudregion.get("cloudOwner")); + } + + @Test + public void testHasProperty(){ + Introspector cloudregion = IntrospectorFactory.newInstance(ModelType.POJO, new CloudRegion()); + assertEquals( true, cloudregion.hasProperty("test")); + } + + @Test + public void testMethodsforExceptions(){ + PojoStrategy ps = new PojoStrategy(new CloudRegion()); + Exception ex = null; + Boolean exceptionThrownForKeys = false; + Boolean exceptionThrownForProcessKeys = false; + try{ + ps.findKey(); + ps.getKeys(); + }catch(Exception e){ + exceptionThrownForKeys= true; + } + try { + ps.getProperties(); + ps.getRequiredProperties(); + ps.getClass("TEST"); + ps.getGenericTypeClass("TEST"); + ps.getJavaClassName(); + ps.getUnderlyingObject(); + ps.clone(); + ps.getChildName(); + ps.getObjectId(); + ps.getPropertyMetadata("TEST"); + ps.getName(); + ps.getVersion(); + }catch(Exception e){ + ex = e; + } + + + try{ + ps.preProcessKey("TEST/TEST/TEST"); + }catch(Exception e){ + exceptionThrownForProcessKeys = true; + } + try{ + ps.set("TEST", new Object()); + }catch(Exception e){ + + } + assertEquals(null, ex); + assertEquals(true, exceptionThrownForKeys); + assertEquals(true, exceptionThrownForProcessKeys); + } + + } diff --git a/aai-core/src/test/java/org/onap/aai/introspection/VersionTest.java b/aai-core/src/test/java/org/onap/aai/introspection/VersionTest.java new file mode 100644 index 00000000..3fec8701 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/VersionTest.java @@ -0,0 +1,50 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection; + +import org.apache.commons.lang3.StringUtils; +import org.junit.Test; + +import static org.hamcrest.Matchers.endsWith; +import static org.junit.Assert.*; + +public class VersionTest { + + @Test + public void isLatest() throws Exception { + assertTrue(Version.isLatest(Version.getVersion("latest"))); + } + + @Test + public void getLatest() throws Exception { + assertEquals(Version.getVersion("latest"), Version.getLatest()); + } + + @Test + public void getVersionLatestString() throws Exception { + assertEquals(Version.getLatest(), Version.getVersion("latest")); + } + + @Test + public void getVersion() throws Exception { + assertEquals(Version.v13, Version.getVersion("v13")); + } + +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/introspection/generator/CreateExampleTest.java b/aai-core/src/test/java/org/onap/aai/introspection/generator/CreateExampleTest.java new file mode 100644 index 00000000..8c373052 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/generator/CreateExampleTest.java @@ -0,0 +1,118 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection.generator; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.Mockito; +import org.onap.aai.AAISetup; +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.*; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class CreateExampleTest extends AAISetup { + + private static CreateExample createExample; + private static Loader loader; + + @BeforeClass + public static void setUp() { + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); + createExample = new CreateExample(loader, "edge-prop-names"); + } + + @Test + public void testGetExampleObject() throws AAIException { + Introspector introspector = loader.introspectorFromName("edge-prop-names"); + Introspector res = createExample.getExampleObject(); + assertEquals(introspector.getName(), res.getName()); + } + + @Test + public void testProcessPrimitiveString() throws AAIUnknownObjectException { + String propName = "direction"; + Introspector introspector = loader.introspectorFromName("edge-prop-names"); + createExample.processPrimitive(propName, introspector); + } + + @Test + public void testProcessPrimitiveLong() throws AAIUnknownObjectException { + String propName = "vlan-id-inner"; + Introspector introspector = loader.introspectorFromName("ctag-assignment"); + createExample.processPrimitive(propName, introspector); + } + + @Test + public void testProcessPrimitiveBoolean() throws AAIUnknownObjectException { + String propName = "in-maint"; + Introspector introspector = loader.introspectorFromName("vserver"); + createExample.processPrimitive(propName, introspector); + } + + @Test + public void testProcessPrimitiveInteger() throws AAIUnknownObjectException { + String propName = "module-index"; + Introspector introspector = loader.introspectorFromName("vf-module"); + createExample.processPrimitive(propName, introspector); + } + + @Test + public void testProcessPrimitiveList() throws AAIUnknownObjectException { + String propName = "ipaddress-v4-vig"; + Introspector introspector = loader.introspectorFromName("vig-server"); + createExample.processPrimitiveList(propName, introspector); + } + + @Test + public void testProcessComplexObj() { + // empty method + Introspector introspector = Mockito.mock(Introspector.class); + createExample.processComplexObj(introspector); + } + + @Test + public void testModifyComplexList() { + // empty method + List introList = new ArrayList(); + List objList = new ArrayList(); + Introspector introspector = Mockito.mock(Introspector.class); + createExample.modifyComplexList(introList, objList, introspector, introspector); + } + + @Test + public void testCreateComplexObjIfNull() { + boolean res = createExample.createComplexObjIfNull(); + assertTrue(res); + } + + @Test + public void testCreateComplexListSize() { + Introspector introspector = Mockito.mock(Introspector.class); + int res = createExample.createComplexListSize(introspector, introspector); + assertEquals(1, res); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataCopyTest.java b/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataCopyTest.java index 250c34cd..27efbdb2 100644 --- a/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataCopyTest.java +++ b/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataCopyTest.java @@ -28,6 +28,8 @@ import org.apache.tinkerpop.gremlin.structure.Vertex; import org.apache.tinkerpop.gremlin.structure.VertexProperty; import org.junit.*; import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.mockito.Mock; import org.mockito.MockitoAnnotations; import org.onap.aai.db.props.AAIProperties; @@ -48,25 +50,36 @@ import java.io.UnsupportedEncodingException; import java.lang.reflect.InvocationTargetException; import java.net.MalformedURLException; import java.net.URISyntaxException; +import java.util.Arrays; +import java.util.Collection; import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; +@RunWith(value = Parameterized.class) public class DataCopyTest { private static TitanGraph graph; private final static Version version = Version.getLatest(); private final static ModelType introspectorFactoryType = ModelType.MOXY; - private final static QueryStyle queryStyle = QueryStyle.TRAVERSAL; private final static DBConnectionType type = DBConnectionType.REALTIME; private static Loader loader; private static TransactionalGraphEngine dbEngine; @Mock private Vertex self; @Mock private VertexProperty prop; @Mock private QueryParser uriQuery; - @Rule - public ExpectedException thrown = ExpectedException.none(); + @Rule public ExpectedException thrown = ExpectedException.none(); + + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } @BeforeClass @@ -75,16 +88,11 @@ public class DataCopyTest { System.setProperty("AJSC_HOME", "."); System.setProperty("BUNDLECONFIG_DIR", "src/test/resources/bundleconfig-local"); loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); - dbEngine = new TitanDBEngine( - queryStyle, - type, - loader); - - graph.traversal().addV("aai-node-type", "model", "model-invariant-id", "key1").as("v1") - .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key2", "model-version", "testValue") + graph.traversal().addV("aai-node-type", "model", "model-invariant-id", "key1", AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key1").as("v1") + .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key2", "model-version", "testValue", AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key1/model-vers/model-ver/key2") .addOutE("org.onap.relationships.inventory.BelongsTo", "v1", EdgeProperty.CONTAINS.toString(), true) - .addV("aai-node-type", "model", "model-invariant-id", "key3").as("v2") - .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key4") + .addV("aai-node-type", "model", "model-invariant-id", "key3", AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key3").as("v2") + .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key4", AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key3/model-vers/model-ver/key4") .addOutE("org.onap.relationships.inventory.BelongsTo", "v2", EdgeProperty.CONTAINS.toString(), true) .next(); graph.tx().commit(); @@ -99,6 +107,10 @@ public class DataCopyTest { @Before public void initMock() { MockitoAnnotations.initMocks(this); + dbEngine = new TitanDBEngine( + queryStyle, + type, + loader); } @Test diff --git a/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataLinkTest.java b/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataLinkTest.java index 3b58f449..59fe8b86 100644 --- a/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataLinkTest.java +++ b/aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataLinkTest.java @@ -27,6 +27,8 @@ import org.apache.tinkerpop.gremlin.structure.Vertex; import org.apache.tinkerpop.gremlin.structure.VertexProperty; import org.junit.*; import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.mockito.Mock; import org.mockito.MockitoAnnotations; import org.onap.aai.AAISetup; @@ -45,18 +47,20 @@ import java.io.UnsupportedEncodingException; import java.lang.reflect.InvocationTargetException; import java.net.MalformedURLException; import java.net.URISyntaxException; +import java.util.Arrays; +import java.util.Collection; import java.util.List; import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; +@RunWith(value = Parameterized.class) public class DataLinkTest extends AAISetup { private static TitanGraph graph; private final static Version version = Version.getLatest(); private final static ModelType introspectorFactoryType = ModelType.MOXY; - private final static QueryStyle queryStyle = QueryStyle.TRAVERSAL; private final static DBConnectionType type = DBConnectionType.REALTIME; private static Loader loader; private static TransactionalGraphEngine dbEngine; @@ -65,32 +69,39 @@ public class DataLinkTest extends AAISetup { @Mock private VertexProperty prop; @Rule public ExpectedException thrown = ExpectedException.none(); - + + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } @BeforeClass public static void setup() throws NoSuchFieldException, SecurityException, Exception { graph = TitanFactory.build().set("storage.backend","inmemory").open(); loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); - dbEngine = new TitanDBEngine( - queryStyle, - type, - loader); - - graph.traversal().addV("aai-node-type", "vpn-binding", "vpn-id", "addKey").as("v1") - .addV("aai-node-type", "vpn-binding", "vpn-id", "modifyKey").as("v2") - .addV("aai-node-type", "route-target", "global-route-target", "modifyTargetKey", "route-target-role", "modifyRoleKey", "linked", true) + + graph.traversal().addV("aai-node-type", "vpn-binding", "vpn-id", "addKey", AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/addKey").as("v1") + .addV("aai-node-type", "vpn-binding", "vpn-id", "modifyKey", AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/modifyKey").as("v2") + .addV("aai-node-type", "route-target", "global-route-target", "modifyTargetKey", "route-target-role", "modifyRoleKey", "linked", true, AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/modifyKey/route-targets/route-target/modifyTargetKey/modifyRoleKey") .addOutE("org.onap.relationships.inventory.BelongsTo", "v2", EdgeProperty.CONTAINS.toString(), true) - .addV("aai-node-type", "vpn-binding", "vpn-id", "deleteKey").as("v3") - .addV("aai-node-type", "route-target", "global-route-target", "deleteTargetKey", "route-target-role", "deleteRoleKey", "linked", true) + .addV("aai-node-type", "vpn-binding", "vpn-id", "deleteKey",AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/deleteKey").as("v3" ) + .addV("aai-node-type", "route-target", "global-route-target", "deleteTargetKey", "route-target-role", "deleteRoleKey", "linked", true, AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/deleteKey/route-targets/route-target/deleteTargetKey/deleteRoleKey") .addOutE("org.onap.relationships.inventory.BelongsTo", "v3", EdgeProperty.CONTAINS.toString(), true) - .addV("aai-node-type", "vpn-binding", "vpn-id", "getKey").as("v4") - .addV("aai-node-type", "route-target", "global-route-target", "getTargetKey", "route-target-role", "getRoleKey", "linked", true) + .addV("aai-node-type", "vpn-binding", "vpn-id", "getKey", AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/getKey").as("v4") + .addV("aai-node-type", "route-target", "global-route-target", "getTargetKey", "route-target-role", "getRoleKey", "linked", true, AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/getKey/route-targets/route-target/getTargetKeyNoLink/getRoleKeyNoLink") .addOutE("org.onap.relationships.inventory.BelongsTo", "v4", EdgeProperty.CONTAINS.toString(), true) - .addV("aai-node-type", "vpn-binding", "vpn-id", "getKeyNoLink").as("v5") - .addV("aai-node-type", "route-target", "global-route-target", "getTargetKeyNoLink", "route-target-role", "getRoleKeyNoLink") + .addV("aai-node-type", "vpn-binding", "vpn-id", "getKeyNoLink", AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/getKeyNoLink").as("v5") + .addV("aai-node-type", "route-target", "global-route-target", "getTargetKeyNoLink", "route-target-role", "getRoleKeyNoLink", AAIProperties.AAI_URI, "/network/vpn-bindings/vpn-binding/getKeyNoLink/route-targets/route-target/getTargetKeyNoLink/getRoleKeyNoLink") .addOutE("org.onap.relationships.inventory.BelongsTo", "v5", EdgeProperty.CONTAINS.toString(), true) .next(); graph.tx().commit(); + + graph.traversal().V().has("aai-uri","/network/vpn-bindings/vpn-binding/deleteKey").properties().forEachRemaining(p->System.out.println(p.key() +" : " + p.value())); } @AfterClass @@ -102,6 +113,10 @@ public class DataLinkTest extends AAISetup { @Before public void initMock() { MockitoAnnotations.initMocks(this); + dbEngine = new TitanDBEngine( + queryStyle, + type, + loader); } @Test @@ -129,7 +144,6 @@ public class DataLinkTest extends AAISetup { assertEquals("route-target vertex found", true, traversal.V() .has(AAIProperties.NODE_TYPE, "route-target").has("global-route-target", "key1").has("route-target-role", "key2").has("linked", true).hasNext()); - g.tx().rollback(); } @@ -194,6 +208,7 @@ public class DataLinkTest extends AAISetup { .has("linked", true) .hasNext() ); + g.tx().rollback(); } diff --git a/aai-core/src/test/java/org/onap/aai/introspection/tools/DefaultFieldsTest.java b/aai-core/src/test/java/org/onap/aai/introspection/tools/DefaultFieldsTest.java new file mode 100644 index 00000000..89b1257f --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/tools/DefaultFieldsTest.java @@ -0,0 +1,79 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection.tools; + +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.introspection.*; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; + +import static junit.framework.TestCase.assertNotNull; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class DefaultFieldsTest extends AAISetup { + + private Loader loader; + private Issue issue; + private DefaultFields defaultFields; + + @Before + public void setup() { + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); + issue = new Issue(); + defaultFields = new DefaultFields(); + } + + @Test + public void testDefaultFieldOfPserverIsSucccessfullyResolved() throws AAIUnknownObjectException { + + Introspector pserver = loader.introspectorFromName("pserver"); + assertNotNull("Unable to load the template introspector", pserver); + + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_REQUIRED_PROP); + issue.setPropName("in-maint"); + issue.setIntrospector(pserver); + + boolean isResolved = defaultFields.resolveIssue(issue); + + assertTrue("Unable to resolve the pserver in-maint default field issue", isResolved); + assertEquals("Introspector didn't successfully modify the pserver in-maint", false, + pserver.getValue("in-maint")); + } + + @Test + public void testDefaultFieldResolverShouldFailWhenResolveOnNonDefaultField() throws AAIUnknownObjectException { + + Introspector pserver = loader.introspectorFromName("pserver"); + assertNotNull("Unable to load the template introspector", pserver); + + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_REQUIRED_PROP); + issue.setPropName("hostname"); + issue.setIntrospector(pserver); + + boolean isResolved = defaultFields.resolveIssue(issue); + + assertFalse("It shouldn't be resolving this issue as hostname is required key", isResolved); + } +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/introspection/tools/InjectKeysFromURITest.java b/aai-core/src/test/java/org/onap/aai/introspection/tools/InjectKeysFromURITest.java new file mode 100644 index 00000000..817934f0 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/tools/InjectKeysFromURITest.java @@ -0,0 +1,94 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection.tools; + +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.introspection.*; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; + +import java.net.URI; + +import static junit.framework.TestCase.assertNotNull; +import static org.eclipse.persistence.jpa.jpql.Assert.fail; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class InjectKeysFromURITest extends AAISetup { + + private Loader loader; + private Issue issue; + private InjectKeysFromURI ik; + + @Before + public void setup() { + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); + issue = new Issue(); + } + @Test + public void testInjectKeysFromURIOfPserverIsNotResolved() throws AAIUnknownObjectException { + try { + ik = new InjectKeysFromURI(loader, new URI("/aai/v12/cloud-infrastructure/complexes")); + }catch(Exception e) { + fail("InjectKeys instantiation threw an exception"); + } + + Introspector pserver = loader.introspectorFromName("pserver"); + pserver.setValue("in-maint",false); + pserver.setValue("hostname", "pserver2"); + assertNotNull("Unable to load the template introspector", pserver); + + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_KEY_PROP); + issue.setPropName("in-maint"); + issue.setIntrospector(pserver); + + Boolean issueResolved = ik.resolveIssue(issue); + + assertFalse("Unable to resolve the pserver in-maint issue", issueResolved); + assertEquals("Introspector didn't successfully modify the pserver in-maint", false, + pserver.getValue("in-maint")); + } + @Test + public void testInjectKeysFromURIOfPserverSuccessfullyResolved() throws AAIUnknownObjectException { + try { + ik = new InjectKeysFromURI(loader, new URI("/aai/v12/cloud-infrastructure/pservers/pserver/pserver1")); + }catch(Exception e) { + fail("InjectKeys instantiation threw an exception"); + } + + Introspector pserver = loader.introspectorFromName("pserver"); + assertNotNull("Unable to load the template introspector", pserver); + + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_KEY_PROP); + issue.setPropName("hostname"); + issue.setIntrospector(pserver); + + Boolean issueResolved = ik.resolveIssue(issue); + + assertTrue("Unable to resolve the pserver hostname default field issue", issueResolved); + assertEquals("Introspector didn't successfully modify the pserver hostname", "pserver1", + pserver.getValue("hostname")); + } + +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/introspection/tools/IntrospectorValidatorTest.java b/aai-core/src/test/java/org/onap/aai/introspection/tools/IntrospectorValidatorTest.java new file mode 100644 index 00000000..7c0539b8 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/tools/IntrospectorValidatorTest.java @@ -0,0 +1,125 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection.tools; + +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.introspection.*; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; + +import static junit.framework.TestCase.assertNotNull; +import static org.eclipse.persistence.jpa.jpql.Assert.fail; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class IntrospectorValidatorTest extends AAISetup { + + private Loader loader; + private Issue issue; + private Introspector introspector; + private IntrospectorValidator.Builder b; + private IntrospectorValidator iv; + + @Before + public void setup() { + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); + issue = new Issue(); + try { + introspector = loader.introspectorFromName("pserver"); + }catch(Exception e){ + fail("Introspector instantiation call threw an exception " + e); + } + b = new IntrospectorValidator.Builder(); + iv = b.build(); + + b.addResolver(new IssueResolver() { + @Override + public boolean resolveIssue(Issue issue) { + return true; + } + }); + //this method does nothing + iv.processPrimitiveList("TEST",introspector); + } + + public void setupIssue(String message, IssueType type, String propName, Introspector introspector){ + issue.setDetail(message); + issue.setType(type); + issue.setPropName(propName); + issue.setIntrospector(introspector); + } + + @Test + public void testIntrospectorValidatorMaxDepth() throws AAIUnknownObjectException { + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + b.restrictDepth(4); + assertEquals("Maximum Depth should be 4", 4, b.getMaximumDepth()); + } + + @Test + public void testIntrospectorValidatorValidationRequired() throws AAIUnknownObjectException { + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + b.validateRequired(true); + assertTrue("Validation should be required", b.getValidateRequired()); + } + + @Test + public void testIntrospectorValidatorValidatedFalse() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + try { + assertFalse("Not currently validated", iv.validate(introspector)); + }catch (Exception e){ + fail("Introspector validate call threw an exception " + e); + } + } + + @Test + public void testIntrospectorValidatorResolveIssues() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + assertTrue("Introspector call to resolve issues should return true", iv.resolveIssues()); + } + + @Test + public void testIntrospectorValidatorGetIssues() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + iv.getIssues(); + } + + @Test + public void testIntrospectorValidatorProcessComplexObject() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + iv.processComplexObj(introspector); + } + + @Test + public void testIntrospectorValidatorCreateComplexListSize() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + assertEquals("create complex list size should return 0", 0, iv.createComplexListSize(introspector, introspector)); + } + + @Test + public void testIntrospectorValidatorGetResolvers() throws AAIUnknownObjectException{ + setupIssue("Some message", IssueType.MISSING_REQUIRED_PROP, "hostname", introspector ); + assertNotNull("Get resolvers should not be null", b.getResolvers()); + } + +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/introspection/tools/RemoveNonVisiblePropertyTest.java b/aai-core/src/test/java/org/onap/aai/introspection/tools/RemoveNonVisiblePropertyTest.java new file mode 100644 index 00000000..cddaf649 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/tools/RemoveNonVisiblePropertyTest.java @@ -0,0 +1,70 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.introspection.tools; + +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.introspection.*; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertNotNull; + +public class RemoveNonVisiblePropertyTest extends AAISetup { + + private Loader loader; + private Issue issue; + private RemoveNonVisibleProperty rn; + + @Before + public void setup(){ + rn = new RemoveNonVisibleProperty(); + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); + } + + @Test + public void testNonVisiblePropertyResolved() throws AAIUnknownObjectException { + Introspector introspector = loader.introspectorFromName("pserver"); + issue = new Issue(); + issue.setDetail("Some message"); + issue.setType(IssueType.PROPERTY_NOT_VISIBLE); + issue.setPropName("in-maint"); + issue.setIntrospector(introspector); + assertTrue("Nonvisible property should be removed", rn.resolveIssue(issue)); + assertNull("Introspector did not remove the non visible property", introspector.getValue("in-maint")); + } + + @Test + public void testNonVisiblePropertyNotResolved() throws AAIUnknownObjectException { + Introspector introspector = loader.introspectorFromName("pserver"); + issue = new Issue(); + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_REQUIRED_PROP); + issue.setPropName("in-maint"); + issue.setIntrospector(introspector); + assertFalse("Nonvisible property not present so should not have been removed", rn.resolveIssue(issue)); + } + + +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/parsers/query/GraphTraversalTest.java b/aai-core/src/test/java/org/onap/aai/parsers/query/GraphTraversalTest.java index b1ddcf6c..02e9efa1 100644 --- a/aai-core/src/test/java/org/onap/aai/parsers/query/GraphTraversalTest.java +++ b/aai-core/src/test/java/org/onap/aai/parsers/query/GraphTraversalTest.java @@ -27,6 +27,8 @@ import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAISetup; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.exceptions.AAIException; @@ -44,6 +46,8 @@ import javax.ws.rs.core.UriBuilder; import java.io.UnsupportedEncodingException; import java.net.URI; import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; import java.util.List; import static org.hamcrest.CoreMatchers.containsString; @@ -51,13 +55,23 @@ import static org.hamcrest.Matchers.hasProperty; import static org.hamcrest.Matchers.is; import static org.junit.Assert.assertEquals; +@RunWith(value = Parameterized.class) public class GraphTraversalTest extends AAISetup { private TransactionalGraphEngine dbEngine; private TransactionalGraphEngine dbEnginev9; - - @Rule - public ExpectedException thrown = ExpectedException.none(); + + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + + @Rule public ExpectedException thrown = ExpectedException.none(); /** * Configure. @@ -68,12 +82,12 @@ public class GraphTraversalTest extends AAISetup { @Before public void configure() throws Exception { dbEngine = - new TitanDBEngine(QueryStyle.TRAVERSAL, + new TitanDBEngine(queryStyle, LoaderFactory.createLoaderForVersion(ModelType.MOXY, AAIProperties.LATEST), false); dbEnginev9 = - new TitanDBEngine(QueryStyle.TRAVERSAL, + new TitanDBEngine(queryStyle, LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v9), false); } diff --git a/aai-core/src/test/java/org/onap/aai/query/builder/ExcludeQueryTest.java b/aai-core/src/test/java/org/onap/aai/query/builder/ExcludeQueryTest.java new file mode 100644 index 00000000..97255f9e --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/query/builder/ExcludeQueryTest.java @@ -0,0 +1,130 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.query.builder; + +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; +import org.apache.tinkerpop.gremlin.structure.Graph; +import org.apache.tinkerpop.gremlin.structure.T; +import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph; +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.db.props.AAIProperties; +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.Loader; +import org.onap.aai.introspection.LoaderFactory; +import org.onap.aai.introspection.ModelType; +import org.onap.aai.serialization.db.EdgeRules; +import org.onap.aai.serialization.db.EdgeType; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertTrue; + +public class ExcludeQueryTest extends AAISetup { + + private Loader loader; + + @Before + public void setup() throws Exception { + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, AAIProperties.LATEST); + } + + private QueryBuilder buildTestQuery(QueryBuilder qb) throws AAIException{ + return qb.createEdgeTraversal(EdgeType.TREE, "cloud-region","availability-zone").getVerticesExcludeByProperty("hypervisor-type", "hypervisortype-11").store("x").cap("x").unfold().dedup(); + } + + @Test + public void gremlinQueryExcludeTest() throws AAIException { + Graph graph = TinkerGraph.open(); + EdgeRules rules = EdgeRules.getInstance(); + GraphTraversalSource g = graph.traversal(); + + Vertex cloudregion = graph.addVertex(T.label, "cloud-region", T.id, "0", "aai-node-type", "cloud-region", "cloud-region-id", "cloud-region-id-1", "cloud-owner", "cloud-owner-1"); + Vertex availibityzone = graph.addVertex(T.label, "availability-zone", T.id, "1", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-1", "hypervisor-type", "hypervisortype-1"); + Vertex availibityzone11 = graph.addVertex(T.label, "availability-zone", T.id, "11", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-11", "hypervisor-type", "hypervisortype-11"); + + + Vertex cloudregion1 = graph.addVertex(T.label, "cloud-region", T.id, "3", "aai-node-type", "cloud-region", "cloud-region-id", "cloud-region-id-10", "cloud-owner", "cloud-owner-10"); + Vertex availibityzone1 = graph.addVertex(T.label, "availability-zone", T.id, "4", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-10", "hypervisor-type", "hypervisortype-10"); + Vertex availibityzone12 = graph.addVertex(T.label, "availability-zone", T.id, "12", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-12", "hypervisor-type", "hypervisortype-12"); + + rules.addTreeEdge(g, cloudregion, availibityzone); + rules.addTreeEdge(g, cloudregion, availibityzone11); + + + + rules.addTreeEdge(g, cloudregion1, availibityzone1); + rules.addTreeEdge(g, cloudregion1, availibityzone12); + + List expected = new ArrayList<>(); + expected.add(availibityzone); + + GremlinTraversal qb = new GremlinTraversal<>(loader, g, cloudregion); + QueryBuilder q = buildTestQuery(qb); + + List results = q.toList(); + + assertTrue("results match", expected.containsAll(results) && results.containsAll(expected)); + } + + @Test + public void traversalQueryExcludeTest() throws AAIException { + Graph graph = TinkerGraph.open(); + EdgeRules rules = EdgeRules.getInstance(); + GraphTraversalSource g = graph.traversal(); + + + Vertex cloudregion = graph.addVertex(T.label, "cloud-region", T.id, "0", "aai-node-type", "cloud-region", "cloud-region-id", "cloud-region-id-1", "cloud-owner", "cloud-owner-1"); + Vertex availibityzone = graph.addVertex(T.label, "availability-zone", T.id, "1", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-1", "hypervisor-type", "hypervisortype-1"); + Vertex availibityzone11 = graph.addVertex(T.label, "availability-zone", T.id, "11", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-11", "hypervisor-type", "hypervisortype-11"); + + + Vertex cloudregion1 = graph.addVertex(T.label, "cloud-region", T.id, "3", "aai-node-type", "cloud-region", "cloud-region-id", "cloud-region-id-10", "cloud-owner", "cloud-owner-10"); + Vertex availibityzone1 = graph.addVertex(T.label, "availability-zone", T.id, "4", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-10", "hypervisor-type", "hypervisortype-10"); + Vertex availibityzone12 = graph.addVertex(T.label, "availability-zone", T.id, "12", "aai-node-type", "availability-zone", "availability-zone-name", "az-name-12", "hypervisor-type", "hypervisortype-12"); + + rules.addTreeEdge(g, cloudregion, availibityzone); + rules.addTreeEdge(g, cloudregion, availibityzone11); + + + + rules.addTreeEdge(g, cloudregion1, availibityzone1); + rules.addTreeEdge(g, cloudregion1, availibityzone12); + + List expected = new ArrayList<>(); + expected.add(availibityzone); + + + + + TraversalQuery qb = new TraversalQuery<>(loader, g, cloudregion); + QueryBuilder q = buildTestQuery(qb); + + List results = q.toList(); + + assertTrue("results match", expected.containsAll(results) && results.containsAll(expected)); + } + + + +} diff --git a/aai-core/src/test/java/org/onap/aai/query/builder/GremlinTraversalTest.java b/aai-core/src/test/java/org/onap/aai/query/builder/GremlinTraversalTest.java index 98ac0dee..3632543f 100644 --- a/aai-core/src/test/java/org/onap/aai/query/builder/GremlinTraversalTest.java +++ b/aai-core/src/test/java/org/onap/aai/query/builder/GremlinTraversalTest.java @@ -19,28 +19,39 @@ */ package org.onap.aai.query.builder; +import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree; import org.apache.tinkerpop.gremlin.structure.Edge; import org.apache.tinkerpop.gremlin.structure.Vertex; public class GremlinTraversalTest extends QueryBuilderTestAbstraction { @Override - protected QueryBuilder getNewEdgeTraversal(Vertex v) { + protected QueryBuilder getNewEdgeTraversalWithTestEdgeRules(Vertex v) { return new GremlinTraversal<>(loader, g, v, testEdgeRules); } @Override - protected QueryBuilder getNewEdgeTraversal() { + protected QueryBuilder getNewEdgeTraversalWithTestEdgeRules() { return new GremlinTraversal<>(loader, g, testEdgeRules); } @Override - protected QueryBuilder getNewVertexTraversal(Vertex v) { + protected QueryBuilder getNewVertexTraversalWithTestEdgeRules(Vertex v) { return new GremlinTraversal<>(loader, g, v, testEdgeRules); } @Override - protected QueryBuilder getNewVertexTraversal() { + protected QueryBuilder getNewVertexTraversalWithTestEdgeRules() { + return new GremlinTraversal<>(loader, g, testEdgeRules); + } + + @Override + protected QueryBuilder getNewTreeTraversalWithTestEdgeRules(Vertex v) { + return new GremlinTraversal<>(loader, g, v, testEdgeRules); + } + + @Override + protected QueryBuilder getNewTreeTraversalWithTestEdgeRules() { return new GremlinTraversal<>(loader, g, testEdgeRules); } diff --git a/aai-core/src/test/java/org/onap/aai/query/builder/QueryBuilderTestAbstraction.java b/aai-core/src/test/java/org/onap/aai/query/builder/QueryBuilderTestAbstraction.java index bd8f078a..9cdab403 100644 --- a/aai-core/src/test/java/org/onap/aai/query/builder/QueryBuilderTestAbstraction.java +++ b/aai-core/src/test/java/org/onap/aai/query/builder/QueryBuilderTestAbstraction.java @@ -19,17 +19,10 @@ */ package org.onap.aai.query.builder; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; - +import com.thinkaurelius.titan.core.TitanFactory; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; import org.apache.tinkerpop.gremlin.process.traversal.step.util.BulkSet; +import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree; import org.apache.tinkerpop.gremlin.structure.Edge; import org.apache.tinkerpop.gremlin.structure.Graph; import org.apache.tinkerpop.gremlin.structure.Vertex; @@ -42,10 +35,15 @@ import org.onap.aai.introspection.LoaderFactory; import org.onap.aai.introspection.ModelType; import org.onap.aai.serialization.db.EdgeRules; import org.onap.aai.serialization.db.EdgeType; - -import com.thinkaurelius.titan.core.TitanFactory; import org.onap.aai.serialization.db.exceptions.NoEdgeRuleFoundException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +import static org.junit.Assert.*; + public abstract class QueryBuilderTestAbstraction extends AAISetup { protected static Loader loader; @@ -83,7 +81,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex vnfc = g.addV("aai-node-type","vnfc","vnfc-name","a-name").next(); testEdgeRules.addEdge(g, gvnf, vnfc, "uses"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "vnfc"); assertEquals(vnfc, tQ.next()); @@ -98,7 +96,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex logicalLink = g.addV("aai-node-type","logical-link","link-name","logical-link-a").next(); testEdgeRules.addEdge(g, lInterface, logicalLink, "sourceLInterface"); - QueryBuilder tQ = getNewVertexTraversal(lInterface); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(lInterface); tQ.createEdgeTraversal(EdgeType.COUSIN, "l-interface", "logical-link"); Vertex next = tQ.next(); @@ -107,7 +105,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { } - + @Test public void createEdgeLinterfaceToLogicalLinkIntrospectorTraversal() throws AAIException { @@ -115,7 +113,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex logicalLink = g.addV("aai-node-type","logical-link","link-name","logical-link-a").next(); testEdgeRules.addEdge(g, lInterface, logicalLink, "sourceLInterface"); - QueryBuilder tQ = getNewVertexTraversal(lInterface); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(lInterface); tQ.createEdgeTraversal(EdgeType.COUSIN, loader.introspectorFromName("l-interface"), loader.introspectorFromName("logical-link")); Vertex next = tQ.next(); @@ -132,7 +130,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex logicalLink = g.addV("aai-node-type","logical-link","link-name","logical-link-a").next(); testEdgeRules.addEdge(g, lInterface, logicalLink, "sourceLInterface"); - QueryBuilder tQ = getNewVertexTraversal(lInterface); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(lInterface); tQ.createEdgeTraversal(EdgeType.COUSIN, lInterface, loader.introspectorFromName("logical-link")); Vertex next = tQ.next(); @@ -150,7 +148,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, vnfc1); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "vnfc"); List list = tQ.toList(); @@ -169,10 +167,10 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, vce, vnfc1); - QueryBuilder tQ1 = getNewVertexTraversal(vce); + QueryBuilder tQ1 = getNewVertexTraversalWithTestEdgeRules(vce); tQ1.createEdgeTraversal(EdgeType.COUSIN, "vce", "vnfc"); - QueryBuilder tQ2 = getNewVertexTraversal(vnfc1); + QueryBuilder tQ2 = getNewVertexTraversalWithTestEdgeRules(vnfc1); tQ2.createEdgeTraversal(EdgeType.COUSIN, "vnfc", "vce"); List list1 = tQ1.toList(); @@ -194,7 +192,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, vce, pserver); - QueryBuilder tQ1 = getNewVertexTraversal(vce); + QueryBuilder tQ1 = getNewVertexTraversalWithTestEdgeRules(vce); tQ1.createEdgeTraversal(EdgeType.COUSIN, "vce", "pserver"); List list = tQ1.toList(); @@ -215,7 +213,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, vnfc1); testEdgeRules.addEdge(g, gvnf, vnfc2, "re-uses"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "vnfc"); List list = tQ.toList(); @@ -237,7 +235,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, vnfc1); testEdgeRules.addEdge(g, pserver, vnfc1); - QueryBuilder tQ = getNewVertexTraversal(vnfc1); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(vnfc1); tQ.createEdgeTraversal(EdgeType.COUSIN, "vnfc", "generic-vnf"); List list = tQ.toList(); @@ -305,7 +303,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, pserver); testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "pserver").dedup(); List list = tQ.toList(); @@ -345,7 +343,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, pserver); testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "pserver").store("x").cap("x").unfold(); List list = tQ.toList(); @@ -385,7 +383,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, pserver); testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "pserver"); List list = tQ.toList(); @@ -405,7 +403,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { testEdgeRules.addEdge(g, gvnf, complex); testEdgeRules.addEdge(g, gvnf, complex, "complex-generic-vnf-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "generic-vnf", "complex"); List list = tQ.toList(); @@ -424,7 +422,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e = testEdgeRules.addEdge(g, vce, pserver); - QueryBuilder tQ1 = getNewEdgeTraversal(vce); + QueryBuilder tQ1 = getNewEdgeTraversalWithTestEdgeRules(vce); tQ1.getEdgesBetween(EdgeType.COUSIN, "vce", "pserver"); List list = tQ1.toList(); @@ -443,7 +441,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e = testEdgeRules.addEdge(g, vce, vnfc1); - QueryBuilder tQ1 = getNewEdgeTraversal(vce); + QueryBuilder tQ1 = getNewEdgeTraversalWithTestEdgeRules(vce); tQ1.getEdgesBetween(EdgeType.COUSIN, "vce", "vnfc"); List list1 = tQ1.toList(); @@ -463,7 +461,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetween(EdgeType.COUSIN, "generic-vnf", "pserver"); List list = tQ.toList(); @@ -484,7 +482,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, complex); Edge e2 = testEdgeRules.addEdge(g, gvnf, complex, "complex-generic-vnf-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetween(EdgeType.COUSIN, "generic-vnf", "complex"); List list = tQ.toList(); @@ -506,7 +504,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, vnfc1); Edge e2 = testEdgeRules.addEdge(g, gvnf, vnfc2, "re-uses"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetween(EdgeType.COUSIN, "generic-vnf", "vnfc"); List list = tQ.toList(); @@ -524,10 +522,10 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex gvnf = g.addV("aai-node-type","generic-vnf","vnf-id","gvnf").next(); Vertex pserver = g.addV("aai-node-type","pserver","hostname","a-name").next(); - Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); - Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); + testEdgeRules.addEdge(g, gvnf, pserver); + testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Collections.emptyList()); } @@ -541,7 +539,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Collections.singletonList("generic-vnf-pserver-B")); List list = tQ.toList(); @@ -561,7 +559,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Arrays.asList("generic-vnf-pserver-B", "generic-vnf-pserver-A")); List list = tQ.toList(); @@ -577,10 +575,10 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex gvnf = getVertex(); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Collections.emptyList()); - List list = tQ.toList(); + tQ.toList(); } @@ -589,8 +587,8 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Vertex gvnf = g.addV("aai-node-type","generic-vnf","vnf-id","gvnf").next(); Vertex pserver = g.addV("aai-node-type","pserver","hostname","a-name").next(); - Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); - Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); + testEdgeRules.addEdge(g, gvnf, pserver); + testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); return gvnf; } @@ -603,7 +601,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Collections.singletonList("generic-vnf-pserver-B")); List list = tQ.toList(); @@ -623,7 +621,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { Edge e1 = testEdgeRules.addEdge(g, gvnf, pserver); Edge e2 = testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewEdgeTraversal(gvnf); + QueryBuilder tQ = getNewEdgeTraversalWithTestEdgeRules(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Arrays.asList("generic-vnf-pserver-B", "generic-vnf-pserver-A")); List list = tQ.toList(); @@ -634,13 +632,17 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { } - protected abstract QueryBuilder getNewEdgeTraversal(Vertex v); + protected abstract QueryBuilder getNewEdgeTraversalWithTestEdgeRules(Vertex v); - protected abstract QueryBuilder getNewEdgeTraversal(); + protected abstract QueryBuilder getNewEdgeTraversalWithTestEdgeRules(); - protected abstract QueryBuilder getNewVertexTraversal(Vertex v); + protected abstract QueryBuilder getNewVertexTraversalWithTestEdgeRules(Vertex v); - protected abstract QueryBuilder getNewVertexTraversal(); + protected abstract QueryBuilder getNewVertexTraversalWithTestEdgeRules(); + + protected abstract QueryBuilder getNewTreeTraversalWithTestEdgeRules(Vertex v); + + protected abstract QueryBuilder getNewTreeTraversalWithTestEdgeRules(); } diff --git a/aai-core/src/test/java/org/onap/aai/query/builder/TraversalQueryTest.java b/aai-core/src/test/java/org/onap/aai/query/builder/TraversalQueryTest.java index d5a0e4ab..1eeca6f0 100644 --- a/aai-core/src/test/java/org/onap/aai/query/builder/TraversalQueryTest.java +++ b/aai-core/src/test/java/org/onap/aai/query/builder/TraversalQueryTest.java @@ -19,16 +19,9 @@ */ package org.onap.aai.query.builder; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; - -import java.io.UnsupportedEncodingException; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.List; - import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__; +import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree; import org.apache.tinkerpop.gremlin.structure.Edge; import org.apache.tinkerpop.gremlin.structure.Vertex; import org.junit.Test; @@ -36,63 +29,86 @@ import org.onap.aai.db.props.AAIProperties; import org.onap.aai.exceptions.AAIException; import org.onap.aai.serialization.db.EdgeType; +import java.io.UnsupportedEncodingException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + public class TraversalQueryTest extends QueryBuilderTestAbstraction { @Override - protected QueryBuilder getNewEdgeTraversal(Vertex v) { + protected QueryBuilder getNewEdgeTraversalWithTestEdgeRules(Vertex v) { return new TraversalQuery<>(loader, g, v, testEdgeRules); } @Override - protected QueryBuilder getNewEdgeTraversal() { + protected QueryBuilder getNewEdgeTraversalWithTestEdgeRules() { return new TraversalQuery<>(loader, g, testEdgeRules); } @Override - protected QueryBuilder getNewVertexTraversal(Vertex v) { + protected QueryBuilder getNewVertexTraversalWithTestEdgeRules(Vertex v) { return new TraversalQuery<>(loader, g, v, testEdgeRules); } @Override + protected QueryBuilder getNewVertexTraversalWithTestEdgeRules() { + return new TraversalQuery<>(loader, g, testEdgeRules); + } + + protected QueryBuilder getNewVertexTraversal() { + return new TraversalQuery<>(loader, g); + } + + @Override + protected QueryBuilder getNewTreeTraversalWithTestEdgeRules(Vertex v) { + return new TraversalQuery<>(loader, g, v, testEdgeRules); + } + + @Override + protected QueryBuilder getNewTreeTraversalWithTestEdgeRules() { return new TraversalQuery<>(loader, g, testEdgeRules); } @Test public void unionQuery() { - QueryBuilder tQ = new TraversalQuery<>(loader, g); - QueryBuilder tQ2 = new TraversalQuery<>(loader, g); - QueryBuilder tQ3 = new TraversalQuery<>(loader, g); + QueryBuilder tQ = getNewVertexTraversal(); + QueryBuilder tQ2 = getNewVertexTraversal(); + QueryBuilder tQ3 = getNewVertexTraversal(); tQ.union( tQ2.getVerticesByProperty("test1", "value1"), tQ3.getVerticesByIndexedProperty("test2", "value2")); - + GraphTraversal expected = __.start() .union(__.has("test1", "value1"),__.has("test2", "value2")); - + assertEquals("they are equal", expected, tQ.getQuery()); - + } @Test public void traversalClones() throws UnsupportedEncodingException, AAIException, URISyntaxException { - QueryBuilder tQ = new TraversalQuery<>(loader, g); + QueryBuilder tQ = getNewVertexTraversal(); QueryBuilder builder = tQ.createQueryFromURI(new URI("network/generic-vnfs/generic-vnf/key1")).getQueryBuilder(); GraphTraversal expected = __.start().has("vnf-id", "key1").has("aai-node-type", "generic-vnf"); GraphTraversal containerExpected = __.start().has("aai-node-type", "generic-vnf"); - + assertEquals("query object", expected.toString(), builder.getQuery().toString()); assertEquals("container query object", containerExpected.toString(), builder.getContainerQuery().getQuery().toString()); - + } @Test public void nestedTraversalClones() throws UnsupportedEncodingException, AAIException, URISyntaxException { - - QueryBuilder tQ = new TraversalQuery<>(loader, g); + + QueryBuilder tQ = getNewVertexTraversal(); QueryBuilder builder = tQ.createQueryFromURI(new URI("network/generic-vnfs/generic-vnf/key1/l-interfaces/l-interface/key2")).getQueryBuilder(); GraphTraversal expected = __.start() .has("vnf-id", "key1") @@ -119,7 +135,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, gvnf, vnfc1); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "vnf", "vnfc"); List list = tQ.toList(); @@ -138,10 +154,10 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, vce, vnfc1); - QueryBuilder tQ1 = new TraversalQuery<>(loader, g, vce, testEdgeRules); + QueryBuilder tQ1 = getNewVertexTraversalWithTestEdgeRules(vce); tQ1.createEdgeTraversal(EdgeType.COUSIN, "vnf", "vnfc"); - QueryBuilder tQ2 = new TraversalQuery<>(loader, g, vnfc1, testEdgeRules); + QueryBuilder tQ2 = getNewVertexTraversalWithTestEdgeRules(vnfc1); tQ2.createEdgeTraversal(EdgeType.COUSIN, "vnfc", "vnf"); List list1 = tQ1.toList(); @@ -163,7 +179,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, vce, pserver); - QueryBuilder tQ1 = new TraversalQuery<>(loader, g, vce, testEdgeRules); + QueryBuilder tQ1 = getNewVertexTraversalWithTestEdgeRules(vce); tQ1.createEdgeTraversal(EdgeType.COUSIN, "vnf", "pserver"); List list = tQ1.toList(); @@ -184,7 +200,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, gvnf, vnfc1); testEdgeRules.addEdge(g, gvnf, vnfc2, "re-uses"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "vnf", "vnfc"); List list = tQ.toList(); @@ -205,7 +221,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, gvnf, pserver); testEdgeRules.addEdge(g, gvnf, pserver, "generic-vnf-pserver-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "vnf", "pserver"); List list = tQ.toList(); @@ -225,7 +241,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { testEdgeRules.addEdge(g, gvnf, complex); testEdgeRules.addEdge(g, gvnf, complex, "complex-generic-vnf-B"); - QueryBuilder tQ = getNewVertexTraversal(gvnf); + QueryBuilder tQ = getNewVertexTraversalWithTestEdgeRules(gvnf); tQ.createEdgeTraversal(EdgeType.COUSIN, "vnf", "complex"); List list = tQ.toList(); @@ -235,7 +251,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { } - - + + } diff --git a/aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java b/aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java index 5abe4daf..6ffc10f6 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java @@ -24,14 +24,18 @@ import org.junit.Before; import org.junit.Ignore; import org.junit.Test; import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAIJunitRunner; import org.onap.aai.HttpTestUtil; import org.onap.aai.PayloadUtil; import org.onap.aai.exceptions.AAIException; +import org.onap.aai.serialization.engines.QueryStyle; import org.skyscreamer.jsonassert.JSONAssert; import javax.ws.rs.core.Response; import java.io.IOException; +import java.util.Arrays; +import java.util.Collection; import static org.junit.Assert.assertEquals; @@ -40,14 +44,24 @@ import static org.junit.Assert.assertEquals; * children nodes associated to it then you should be able to * remove the cloud region without removing the individual child nodes first */ -@RunWith(AAIJunitRunner.class) +@RunWith(value = AAIJunitRunner.class) public class CloudRegionTest { private HttpTestUtil httpTestUtil; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before public void setUp(){ - httpTestUtil = new HttpTestUtil(); + httpTestUtil = new HttpTestUtil(queryStyle); } @Ignore("Test is failing due to the deletion of node with children not correct will be fixed soon") @@ -70,5 +84,4 @@ public class CloudRegionTest { response = httpTestUtil.doDelete(cloudRegionUri, resourceVersion); assertEquals("Expected the cloud region to be deleted", 204, response.getStatus()); } - } diff --git a/aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java b/aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java index 9f8045b8..14ff6d5a 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java @@ -23,25 +23,40 @@ import org.json.JSONObject; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAIJunitRunner; +import org.onap.aai.AAISetup; import org.onap.aai.HttpTestUtil; import org.onap.aai.PayloadUtil; +import org.onap.aai.serialization.engines.QueryStyle; import org.skyscreamer.jsonassert.JSONAssert; import javax.ws.rs.core.Response; +import java.util.Arrays; +import java.util.Collection; import java.util.HashMap; import java.util.Map; import static org.junit.Assert.assertEquals; -@RunWith(AAIJunitRunner.class) -public class GenericVnfLInterfaceTest { +@RunWith(value = AAIJunitRunner.class) +public class GenericVnfLInterfaceTest extends AAISetup { private HttpTestUtil httpTestUtil; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before public void setUp(){ - httpTestUtil = new HttpTestUtil(); + httpTestUtil = new HttpTestUtil(queryStyle); } @Test @@ -57,7 +72,8 @@ public class GenericVnfLInterfaceTest { response = httpTestUtil.doGet("/aai/v12/network/generic-vnfs/generic-vnf/vnf1"); assertEquals("Expecting the generic vnf to be updated", 200, response.getStatus()); - resource = response.getEntity().toString().replaceAll("ipv1\",\"resource-version\":\"\\d+\"", "ipv2\""); + resource = response.getEntity().toString(); + resource = resource.replaceAll("ipv1\",\"resource-version\":\"\\d+\"", "ipv2\""); response = httpTestUtil.doPut("/aai/v12/network/generic-vnfs/generic-vnf/vnf1", resource); assertEquals("Expecting the generic vnf to be updated", 200, response.getStatus()); diff --git a/aai-core/src/test/java/org/onap/aai/rest/HPACapabilityTest.java b/aai-core/src/test/java/org/onap/aai/rest/HPACapabilityTest.java index ed7d8e36..279b9c73 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/HPACapabilityTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/HPACapabilityTest.java @@ -25,20 +25,17 @@ import com.jayway.jsonpath.JsonPath; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAIJunitRunner; import org.onap.aai.HttpTestUtil; import org.onap.aai.PayloadUtil; -import org.onap.aai.introspection.*; +import org.onap.aai.serialization.engines.QueryStyle; import org.skyscreamer.jsonassert.JSONAssert; import javax.ws.rs.core.Response; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.UUID; +import java.util.*; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; @RunWith(AAIJunitRunner.class) public class HPACapabilityTest { @@ -47,9 +44,19 @@ public class HPACapabilityTest { private HttpTestUtil httpTestUtil; private Map templateValuesMap; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before public void setup() { - httpTestUtil = new HttpTestUtil(); + httpTestUtil = new HttpTestUtil(queryStyle); templateValuesMap = new HashMap<>(); } diff --git a/aai-core/src/test/java/org/onap/aai/rest/PserverTest.java b/aai-core/src/test/java/org/onap/aai/rest/PserverTest.java index d97c706b..32c7483f 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/PserverTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/PserverTest.java @@ -25,29 +25,43 @@ import com.jayway.jsonpath.JsonPath; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAIJunitRunner; import org.onap.aai.HttpTestUtil; import org.onap.aai.PayloadUtil; import org.onap.aai.introspection.*; +import org.onap.aai.serialization.engines.QueryStyle; import org.skyscreamer.jsonassert.JSONAssert; import javax.ws.rs.core.Response; +import java.util.Arrays; +import java.util.Collection; import java.util.HashMap; import java.util.Map; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; -@RunWith(AAIJunitRunner.class) +@RunWith(value = AAIJunitRunner.class) public class PserverTest { private static EELFLogger logger = EELFManager.getInstance().getLogger(PserverTest.class); private HttpTestUtil httpTestUtil; private Map relationshipMap; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before - public void setup(){ - httpTestUtil = new HttpTestUtil(); + public void setUp(){ + httpTestUtil = new HttpTestUtil(queryStyle); relationshipMap = new HashMap<>(); } diff --git a/aai-core/src/test/java/org/onap/aai/rest/TenantTest.java b/aai-core/src/test/java/org/onap/aai/rest/TenantTest.java index d454c783..72ea49ad 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/TenantTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/TenantTest.java @@ -24,28 +24,37 @@ import org.junit.Before; import org.junit.Ignore; import org.junit.Test; import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAIJunitRunner; import org.onap.aai.HttpTestUtil; import org.onap.aai.PayloadUtil; +import org.onap.aai.serialization.engines.QueryStyle; import org.skyscreamer.jsonassert.JSONAssert; import javax.ws.rs.core.Response; -import java.util.HashMap; -import java.util.Map; -import java.util.UUID; +import java.util.*; import static org.junit.Assert.assertEquals; -@RunWith(AAIJunitRunner.class) +@RunWith(value = AAIJunitRunner.class) public class TenantTest { private HttpTestUtil httpTestUtil; - private Map templateValuesMap; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before - public void setup(){ - httpTestUtil = new HttpTestUtil(); + public void setUp(){ + httpTestUtil = new HttpTestUtil(queryStyle); templateValuesMap = new HashMap<>(); } diff --git a/aai-core/src/test/java/org/onap/aai/rest/db/HttpEntryTest.java b/aai-core/src/test/java/org/onap/aai/rest/db/HttpEntryTest.java index cf6f1774..6ff75c7f 100644 --- a/aai-core/src/test/java/org/onap/aai/rest/db/HttpEntryTest.java +++ b/aai-core/src/test/java/org/onap/aai/rest/db/HttpEntryTest.java @@ -19,41 +19,40 @@ */ package org.onap.aai.rest.db; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; import org.javatuples.Pair; import org.junit.Before; import org.junit.FixMethodOrder; -import org.junit.runners.MethodSorters; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.MethodSorters; +import org.junit.runners.Parameterized; import org.mockito.Mockito; import org.onap.aai.AAISetup; import org.onap.aai.dbmap.DBConnectionType; -import org.onap.aai.domain.yang.Pserver; -import org.onap.aai.domain.yang.Pservers; import org.onap.aai.exceptions.AAIException; -import org.onap.aai.introspection.*; +import org.onap.aai.introspection.Introspector; +import org.onap.aai.introspection.Loader; +import org.onap.aai.introspection.ModelType; +import org.onap.aai.introspection.Version; import org.onap.aai.parsers.query.QueryParser; import org.onap.aai.restcore.HttpMethod; import org.onap.aai.serialization.engines.QueryStyle; import org.onap.aai.serialization.engines.TransactionalGraphEngine; import javax.ws.rs.core.*; - -import java.io.BufferedReader; -import java.io.InputStream; -import java.io.InputStreamReader; import java.io.UnsupportedEncodingException; import java.net.URI; import java.util.*; -import java.util.stream.Collectors; - -import com.google.gson.JsonObject; -import com.google.gson.JsonParser; +import static org.hamcrest.Matchers.containsString; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.assertThat; import static org.mockito.Matchers.anyObject; import static org.mockito.Mockito.when; +@RunWith(value = Parameterized.class) @FixMethodOrder(MethodSorters.NAME_ASCENDING) public class HttpEntryTest extends AAISetup { @@ -67,6 +66,16 @@ public class HttpEntryTest extends AAISetup { VALID_HTTP_STATUS_CODES.add(204); } + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + private HttpHeaders httpHeaders; private UriInfo uriInfo; @@ -114,7 +123,7 @@ public class HttpEntryTest extends AAISetup { when(httpHeaders.getMediaType()).thenReturn(APPLICATION_JSON); } - private Response getResponse(HttpEntry httpEntry, Loader loader, TransactionalGraphEngine dbEngine, HttpMethod method, String uri, String content) throws UnsupportedEncodingException, AAIException { + private Response doRequest(HttpEntry httpEntry, Loader loader, TransactionalGraphEngine dbEngine, HttpMethod method, String uri, String content) throws UnsupportedEncodingException, AAIException { URI uriObject = UriBuilder.fromPath(uri).build(); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); String objType = uriQuery.getResultType(); @@ -144,13 +153,13 @@ public class HttpEntryTest extends AAISetup { public void test1PutOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = "{\"hostname\":\"junit-test1\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be created", 201, response.getStatus()); } @@ -159,13 +168,13 @@ public class HttpEntryTest extends AAISetup { public void test2PutOnPserverNoPInterface() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; String content = "{\"hostname\":\"junit-test2\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be created", 201, response.getStatus()); } @@ -174,13 +183,13 @@ public class HttpEntryTest extends AAISetup { public void test3PutOnPInterface() { try { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test1/p-interfaces/p-interface/p1"; String content = "{\"interface-name\":\"p1\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); dbEngine.commit(); assertEquals("Expected the p-interface to be created", 201, response.getStatus()); } catch (UnsupportedEncodingException | AAIException e) { @@ -195,7 +204,7 @@ public class HttpEntryTest extends AAISetup { public void test4GetOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); @@ -203,7 +212,7 @@ public class HttpEntryTest extends AAISetup { String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = "{\"hostname\":\"junit-test1\", \"equip-type\":\"junit-equip-type\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be returned", 200, response.getStatus()); } @@ -212,13 +221,13 @@ public class HttpEntryTest extends AAISetup { public void test5MergePatchOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = "{\"hostname\":\"junit-test1\", \"equip-type\":\"junit-equip-type\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.MERGE_PATCH, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.MERGE_PATCH, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be updated", 200, response.getStatus()); } @@ -226,7 +235,7 @@ public class HttpEntryTest extends AAISetup { private int doDelete(String resourceVersion, String uri, String nodeType) throws UnsupportedEncodingException, AAIException { queryParameters.add("resource-version", resourceVersion); DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); @@ -256,14 +265,14 @@ public class HttpEntryTest extends AAISetup { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = ""; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); dbEngine.commit(); String msg = response.getEntity().toString(); JsonObject jsonObj = new JsonParser().parse(msg).getAsJsonObject(); @@ -279,13 +288,13 @@ public class HttpEntryTest extends AAISetup { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; String content = ""; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); dbEngine.commit(); String msg = response.getEntity().toString(); JsonObject jsonObj = new JsonParser().parse(msg).getAsJsonObject(); @@ -301,13 +310,13 @@ public class HttpEntryTest extends AAISetup { public void test8FailedGetOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; String content = ""; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be deleted", 404, response.getStatus()); @@ -317,55 +326,89 @@ public class HttpEntryTest extends AAISetup { public void putEdgeTest() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); //Put pserver String uri = "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver"; String content = "{\"hostname\":\"junit-edge-test-pserver\"}"; - getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); //Put complex uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex"; content = "{\"physical-location-id\":\"junit-edge-test-complex\",\"physical-location-type\":\"AAIDefault\",\"street1\":\"AAIDefault\",\"city\":\"AAIDefault\",\"state\":\"NJ\",\"postal-code\":\"07748\",\"country\":\"USA\",\"region\":\"US\"}"; - getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); //PutEdge uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex/relationship-list/relationship"; content = "{\"related-to\":\"pserver\",\"related-link\":\"/aai/" + Version.getLatest().toString() + "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver\",\"relationship-label\":\"org.onap.relationships.inventory.LocatedIn\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT_EDGE, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT_EDGE, uri, content); dbEngine.rollback(); //System.out.println(response.getEntity().toString()); - assertEquals("Expected the pserver to be created", 200, response.getStatus()); + assertEquals("Expected the pserver relationship to be created", 200, response.getStatus()); } @Test public void putEdgeWrongLabelTest() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; - HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); //Put pserver String uri = "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver"; String content = "{\"hostname\":\"junit-edge-test-pserver\"}"; - getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); //Put complex uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex"; content = "{\"physical-location-id\":\"junit-edge-test-complex\",\"physical-location-type\":\"AAIDefault\",\"street1\":\"AAIDefault\",\"city\":\"AAIDefault\",\"state\":\"NJ\",\"postal-code\":\"07748\",\"country\":\"USA\",\"region\":\"US\"}"; - getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); //PutEdge uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex/relationship-list/relationship"; content = "{\"related-to\":\"pserver\",\"related-link\":\"/aai/" + Version.getLatest().toString() + "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver\",\"relationship-label\":\"junk\"}"; - Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT_EDGE, uri, content); + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT_EDGE, uri, content); dbEngine.rollback(); String msg = response.getEntity().toString(); assertEquals("Expected the pserver to be created", 400, response.getStatus()); - assertTrue(msg.contains("ERR.5.4.6107")); - assertTrue(msg.contains("Required Edge-property not found in input data:no COUSIN edge rule between complex and pserver with label junk")); + assertThat(msg, containsString("ERR.5.4.6107")); + assertThat(msg, containsString("Required Edge-property not found in input data:no COUSIN edge rule between complex and pserver with label junk")); + + } + + @Test + public void relatedToTest() throws UnsupportedEncodingException, AAIException { + + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, queryStyle, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); + + //Put pserver + String uri = "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver"; + String content = "{\"hostname\":\"junit-edge-test-pserver\"}"; + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + //Put complex + uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex"; + content = "{\"physical-location-id\":\"junit-edge-test-complex\",\"physical-location-type\":\"AAIDefault\",\"street1\":\"AAIDefault\",\"city\":\"AAIDefault\",\"state\":\"NJ\",\"postal-code\":\"07748\",\"country\":\"USA\",\"region\":\"US\"}"; + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + + //PutEdge + uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex/relationship-list/relationship"; + content = "{\"related-to\":\"pserver\",\"related-link\":\"/aai/" + Version.getLatest().toString() + "/cloud-infrastructure/pservers/pserver/junit-edge-test-pserver\",\"relationship-label\":\"org.onap.relationships.inventory.LocatedIn\"}"; + doRequest(httpEntry, loader, dbEngine, HttpMethod.PUT_EDGE, uri, content); + + //getRelatedTo + uri = "/cloud-infrastructure/complexes/complex/junit-edge-test-complex/related-to/pservers"; + content = ""; + Response response = doRequest(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + String respBody = response.getEntity().toString(); + + dbEngine.rollback(); + assertEquals("Expected the pserver to be created", 200, response.getStatus()); + assertThat("Related to pserver is returned.", respBody, containsString("\"hostname\":\"junit-edge-test-pserver\"")); } -} +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/serialization/db/DbAliasTest.java b/aai-core/src/test/java/org/onap/aai/serialization/db/DbAliasTest.java index e00c7eb3..27d14c94 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/db/DbAliasTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/db/DbAliasTest.java @@ -27,6 +27,8 @@ import org.apache.tinkerpop.gremlin.structure.Vertex; import org.junit.After; import org.junit.Before; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAISetup; import org.onap.aai.dbmap.DBConnectionType; import org.onap.aai.exceptions.AAIException; @@ -42,6 +44,8 @@ import java.lang.reflect.InvocationTargetException; import java.net.MalformedURLException; import java.net.URI; import java.net.URISyntaxException; +import java.util.Arrays; +import java.util.Collection; import java.util.Collections; import java.util.Map; @@ -49,17 +53,27 @@ import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; +@RunWith(value = Parameterized.class) public class DbAliasTest extends AAISetup { private TitanGraph graph; private final Version version = Version.v9; private final ModelType introspectorFactoryType = ModelType.MOXY; - private final QueryStyle queryStyle = QueryStyle.TRAVERSAL; private final DBConnectionType type = DBConnectionType.REALTIME; private Loader loader; private TransactionalGraphEngine dbEngine; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @Before public void setup() throws Exception { graph = TitanFactory.build().set("storage.backend","inmemory").open(); diff --git a/aai-core/src/test/java/org/onap/aai/serialization/db/DbSerializerTest.java b/aai-core/src/test/java/org/onap/aai/serialization/db/DbSerializerTest.java index cff374ca..3cf43b4a 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/db/DbSerializerTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/db/DbSerializerTest.java @@ -19,40 +19,35 @@ */ package org.onap.aai.serialization.db; -import static org.junit.Assert.*; -import static org.mockito.Mockito.spy; -import static org.mockito.Mockito.when; - -import java.io.UnsupportedEncodingException; -import java.lang.reflect.Field; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.*; - +import com.thinkaurelius.titan.core.TitanFactory; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; -import org.apache.tinkerpop.gremlin.structure.Edge; -import org.apache.tinkerpop.gremlin.structure.Graph; -import org.apache.tinkerpop.gremlin.structure.T; -import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.apache.tinkerpop.gremlin.structure.*; import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph; import org.junit.*; import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; import org.onap.aai.AAISetup; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.dbmap.DBConnectionType; import org.onap.aai.exceptions.AAIException; -import org.onap.aai.introspection.Introspector; -import org.onap.aai.introspection.Loader; -import org.onap.aai.introspection.LoaderFactory; -import org.onap.aai.introspection.ModelType; -import org.onap.aai.introspection.Version; +import org.onap.aai.introspection.*; import org.onap.aai.parsers.query.QueryParser; import org.onap.aai.serialization.engines.QueryStyle; import org.onap.aai.serialization.engines.TitanDBEngine; import org.onap.aai.serialization.engines.TransactionalGraphEngine; -import com.thinkaurelius.titan.core.TitanFactory; +import java.io.UnsupportedEncodingException; +import java.lang.reflect.Field; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.*; + +import static org.junit.Assert.*; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; +@RunWith(value = Parameterized.class) public class DbSerializerTest extends AAISetup { //to use, set thrown.expect to whatever your test needs @@ -65,7 +60,6 @@ public class DbSerializerTest extends AAISetup { private final Version version = Version.getLatest(); private final ModelType introspectorFactoryType = ModelType.MOXY; - private final QueryStyle queryStyle = QueryStyle.TRAVERSAL; private final DBConnectionType type = DBConnectionType.REALTIME; private Loader loader; private TransactionalGraphEngine dbEngine; @@ -74,15 +68,25 @@ public class DbSerializerTest extends AAISetup { TransactionalGraphEngine spy; TransactionalGraphEngine.Admin adminSpy; + @Parameterized.Parameter(value = 0) + public QueryStyle queryStyle; + + @Parameterized.Parameters(name = "QueryStyle.{0}") + public static Collection data() { + return Arrays.asList(new Object[][]{ + {QueryStyle.TRAVERSAL} + }); + } + @BeforeClass public static void init() throws Exception { graph = TitanFactory.build().set("storage.backend", "inmemory").open(); - createGraph(); } @Before public void setup() throws Exception { + //createGraph(); loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); dbEngine = new TitanDBEngine(queryStyle, type, loader); spy = spy(dbEngine); @@ -93,29 +97,6 @@ public class DbSerializerTest extends AAISetup { dbser = new DBSerializer(version, engine, introspectorFactoryType, "AAI-TEST"); } - public static void createGraph() throws AAIException { - /* - * This setus up the test graph, For future junits , add more vertices - * and edges - */ - - Vertex l3interipv4addresslist_1 = graph.traversal().addV("aai-node-type", "l3-interface-ipv4-address-list", - "l3-interface-ipv4-address", "l3-interface-ipv4-address-1").next(); - Vertex subnet_2 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-2").next(); - Vertex l3interipv6addresslist_3 = graph.traversal().addV("aai-node-type", "l3-interface-ipv6-address-list", - "l3-interface-ipv6-address", "l3-interface-ipv6-address-3").next(); - Vertex subnet_4 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-4").next(); - Vertex subnet_5 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-5").next(); - Vertex l3network_6 = graph.traversal() - .addV("aai-node-type", "l3-network", "network-id", "network-id-6", "network-name", "network-name-6") - .next(); - - GraphTraversalSource g = graph.traversal(); - EdgeRules.getInstance().addEdge(g, l3interipv4addresslist_1, subnet_2); - EdgeRules.getInstance().addEdge(g, l3interipv6addresslist_3, subnet_4); - EdgeRules.getInstance().addTreeEdge(g, subnet_5, l3network_6); - } - @Test public void testFindDeletableDoesNotReturnDuplicates() throws AAIException { @@ -166,8 +147,33 @@ public class DbSerializerTest extends AAISetup { graph.close(); } + + public void subnetSetup() throws AAIException { + /* + * This setus up the test graph, For future junits , add more vertices + * and edges + */ + + Vertex l3interipv4addresslist_1 = graph.traversal().addV("aai-node-type", "l3-interface-ipv4-address-list", + "l3-interface-ipv4-address", "l3-interface-ipv4-address-1").next(); + Vertex subnet_2 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-2").next(); + Vertex l3interipv6addresslist_3 = graph.traversal().addV("aai-node-type", "l3-interface-ipv6-address-list", + "l3-interface-ipv6-address", "l3-interface-ipv6-address-3").next(); + Vertex subnet_4 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-4").next(); + Vertex subnet_5 = graph.traversal().addV("aai-node-type", "subnet", "subnet-id", "subnet-id-5").next(); + Vertex l3network_6 = graph.traversal() + .addV("aai-node-type", "l3-network", "network-id", "network-id-6", "network-name", "network-name-6") + .next(); + + GraphTraversalSource g = graph.traversal(); + EdgeRules.getInstance().addEdge(g, l3interipv4addresslist_1, subnet_2); + EdgeRules.getInstance().addEdge(g, l3interipv6addresslist_3, subnet_4); + EdgeRules.getInstance().addTreeEdge(g, subnet_5, l3network_6); + } + @Test public void subnetDelWithInEdgesIpv4Test() throws AAIException { + subnetSetup(); String expected_message = "Object is being reference by additional objects preventing it from being deleted. Please clean up references from the following types [l3-interface-ipv4-address-list]"; /* @@ -182,6 +188,7 @@ public class DbSerializerTest extends AAISetup { @Test public void subnetDelWithInEdgesIpv6Test() throws AAIException { + subnetSetup(); String expected_message = "Object is being reference by additional objects preventing it from being deleted. Please clean up references from the following types [l3-interface-ipv6-address-list]"; /* @@ -195,6 +202,7 @@ public class DbSerializerTest extends AAISetup { @Test public void subnetDelWithInEdgesL3network() throws AAIException { + subnetSetup(); String expected_message = ""; /* @@ -277,6 +285,37 @@ public class DbSerializerTest extends AAISetup { } } + @Test + public void serializeToDbNewVertexAndEdgeAAIUUIDTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { + String testName = new Object() {}.getClass().getEnclosingMethod().getName(); + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); + DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); + + engine.startTransaction(); + + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","vnfc-" + testName, AAIProperties.AAI_URI, "/network/vnfcs/vnfc/vnfc-" + testName); + + Introspector relationship = loader.introspectorFromName("relationship"); + relationship.setValue("related-to", "vnfc"); + relationship.setValue("related-link", "/network/vnfcs/vnfc/vnfc-" + testName); + + Introspector relationshipList = loader.introspectorFromName("relationship-list"); + relationshipList.setValue("relationship", Collections.singletonList(relationship.getUnderlyingObject())); + + Introspector gvnfObj = loader.introspectorFromName("generic-vnf"); + Vertex gvnf = localDbser.createNewVertex(gvnfObj); + gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); + gvnfObj.setValue("vnf-id", "vnf-" + testName); + + QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/vnf-" + testName)); + + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); + assertTrue("Generic-vnf has uuid ", gvnf.property(AAIProperties.AAI_UUID).isPresent()); + assertTrue("Edge has uuid ", gvnf.edges(Direction.BOTH).next().property(AAIProperties.AAI_UUID).isPresent()); + + + } + @Test public void verifyResourceVersion_SunnyDayTest() throws AAIException { engine.startTransaction(); @@ -400,8 +439,8 @@ public class DbSerializerTest extends AAISetup { public void deleteEdgeTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); EdgeRules rules = EdgeRules.getInstance(); rules.addEdge(engine.tx().traversal(), gvnf, vnfc); @@ -424,8 +463,8 @@ public class DbSerializerTest extends AAISetup { public void createEdgeTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); //sunny day case Introspector relData = loader.introspectorFromName("relationship-data"); @@ -446,8 +485,8 @@ public class DbSerializerTest extends AAISetup { public void createCousinEdgeThatShouldBeTreeTest() throws AAIException, UnsupportedEncodingException, URISyntaxException { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vf = engine.tx().addVertex("aai-node-type","vf-module","vf-module-id","vf-id"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vf = engine.tx().addVertex("aai-node-type","vf-module","vf-module-id","vf-id", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf/vf-modules/vf-module/vf-id"); EdgeRules.getInstance().addTreeEdge(engine.tx().traversal(), gvnf, vf); @@ -475,7 +514,7 @@ public class DbSerializerTest extends AAISetup { public void createEdgeNodeDoesNotExistExceptionTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); //rainy day case, edge to non-existent object Introspector relData = loader.introspectorFromName("relationship-data"); @@ -579,8 +618,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); //sunny day case Introspector relData = loader.introspectorFromName("relationship-data"); @@ -603,8 +642,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relData = loader.introspectorFromName("relationship-data"); relData.setValue("relationship-key", "vnfc.vnfc-name"); @@ -630,8 +669,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); ers.addEdge(graph.traversal(), gvnf, vnfc, "re-uses"); Introspector relData = loader.introspectorFromName("relationship-data"); @@ -658,8 +697,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); ers.addEdge(graph.traversal(), gvnf, vnfc, "uses"); Introspector relData = loader.introspectorFromName("relationship-data"); @@ -692,8 +731,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relData = loader.introspectorFromName("relationship-data"); relData.setValue("relationship-key", "vnfc.vnfc-name"); @@ -722,8 +761,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); ers.addEdge(graph.traversal(), gvnf, vnfc, "uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "re-uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "over-uses"); @@ -756,8 +795,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); ers.addEdge(graph.traversal(), gvnf, vnfc, "uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "re-uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "over-uses"); @@ -791,8 +830,8 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); - Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf", "aai-uri", "/network/generic-vnfs/generic-vnf/myvnf"); + Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); ers.addEdge(graph.traversal(), gvnf, vnfc, "uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "re-uses"); ers.addEdge(graph.traversal(), gvnf, vnfc, "over-uses"); @@ -819,7 +858,7 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); @@ -858,7 +897,7 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); @@ -897,7 +936,7 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); @@ -926,7 +965,7 @@ public class DbSerializerTest extends AAISetup { DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); engine.startTransaction(); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); Introspector relationship; Introspector relationshipList; @@ -982,7 +1021,8 @@ public class DbSerializerTest extends AAISetup { DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); engine.startTransaction(); - engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name", "aai-uri", "/network/vnfcs/vnfc/a-name"); + Introspector relationship; Introspector relationshipList; @@ -1145,14 +1185,15 @@ public class DbSerializerTest extends AAISetup { ModelType.MOXY, "AAI-TEST"); engine.startTransaction(); - Vertex gv = engine.tx().addVertex("aai-node-type", "generic-vnf", "vnf-id", "id1"); - Vertex lint = engine.tx().addVertex("aai-node-type", "l-interface", "interface-name", "name1"); + Vertex gv = engine.tx().addVertex("aai-node-type", "generic-vnf", "vnf-id", "id1", "aai-uri", "/network/generic-vnfs/generic-vnf/id1"); + Vertex lint = engine.tx().addVertex("aai-node-type", "l-interface"); rules.addTreeEdge(engine.tx().traversal(), gv, lint); Introspector lintIntro = loader.introspectorFromName("l-interface"); + lintIntro.setValue("interface-name", "name1"); lintIntro.setValue("interface-role", "actor"); URI lintURI = new URI("/network/generic-vnfs/generic-vnf/id1/l-interfaces/l-interface/name1"); - QueryParser uriQuery = dbEngine.getQueryBuilder(gv).createQueryFromURI(lintURI); + QueryParser uriQuery = engine.getQueryBuilder(gv).createQueryFromURI(lintURI); dbser.serializeToDb(lintIntro, lint, uriQuery, "test-identifier", "AAI-TEST"); assertTrue(engine.tx().traversal().V(lint).has("interface-role", "actor").hasNext()); @@ -1174,4 +1215,4 @@ public class DbSerializerTest extends AAISetup { assertTrue("very-fast".equals(res.getValue("speed-value"))); assertTrue("things".equals(res.getValue("service-provider-bandwidth-up-units"))); } -} \ No newline at end of file +} diff --git a/aai-core/src/test/java/org/onap/aai/serialization/db/EdgeRulesTest.java b/aai-core/src/test/java/org/onap/aai/serialization/db/EdgeRulesTest.java index 81d4c885..60691acb 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/db/EdgeRulesTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/db/EdgeRulesTest.java @@ -157,7 +157,6 @@ public class EdgeRulesTest extends AAISetup { assertEquals(true, "IN".equalsIgnoreCase(rule.getContains())); assertEquals(true, "NONE".equalsIgnoreCase(rule.getDeleteOtherV())); assertEquals(true, MultiplicityRule.MANY2ONE.equals(rule.getMultiplicityRule())); - assertEquals(true, "OUT".equalsIgnoreCase(rule.getServiceInfrastructure())); assertEquals(true, "IN".equalsIgnoreCase(rule.getPreventDelete())); } @@ -241,23 +240,6 @@ public class EdgeRulesTest extends AAISetup { rules.getAllRules(); } - @Test - public void getChildrenMissingPropertyTest() { - EdgeRules rules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test_broken.json"); - - thrown.expect(RuntimeException.class); - thrown.expectMessage("org.onap.aai.exceptions.AAIException: Rule between quux and foo is missing property SVC-INFRA."); - rules.getChildren("foo"); - } - - @Test - public void getEdgeRuleMissingPropertyTest() throws AAIException { - EdgeRules rules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test_broken.json"); - - thrown.expect(RuntimeException.class); - rules.getEdgeRules("foo", "quux"); - } - @Test public void verifyAllRules() { // This will cause every rule in the real json files to be verified diff --git a/aai-core/src/test/java/org/onap/aai/util/AAIConfigTest.java b/aai-core/src/test/java/org/onap/aai/util/AAIConfigTest.java new file mode 100644 index 00000000..deefdc1b --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/AAIConfigTest.java @@ -0,0 +1,125 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import java.net.InetAddress; +import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Properties; + +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.exceptions.AAIException; + +public class AAIConfigTest extends AAISetup { + + @BeforeClass + public static void setUp() throws AAIException { + AAIConfig.init(); + } + + @Test + public void testGetDefaultBools() { + HashMap> res = AAIConfig.getDefaultBools(); + assertNotNull(res); + assertEquals(6, res.size()); + assertEquals("in-maint", res.get("generic-vnf").get(0)); + assertEquals("is-closed-loop-disabled", res.get("generic-vnf").get(1)); + assertEquals("is-bound-to-vpn", res.get("l3-network").get(0)); + assertEquals("in-maint", res.get("pserver").get(0)); + assertEquals("dhcp-enabled", res.get("subnet").get(0)); + assertEquals("in-maint", res.get("vserver").get(0)); + assertEquals("is-closed-loop-disabled", res.get("vserver").get(1)); + assertEquals("in-maint", res.get("vnfc").get(0)); + assertEquals("is-closed-loop-disabled", res.get("vnfc").get(1)); + } + + @Test + public void testGetConfigFile() { + String res = AAIConfig.getConfigFile(); + assertNotNull(res); + assertTrue(res.endsWith("aaiconfig.properties")); + } + + @Test + public void testGetStringStringReturnDefaultvalue() { + String res = AAIConfig.get("key", "result"); + assertNotNull(res); + assertEquals("result", res); + } + + @Test(expected = AAIException.class) + public void testGetStringInvalidKey() throws AAIException { + AAIConfig.get("key"); + } + + @Test(expected = AAIException.class) + public void testGetStringEmptyResponse() throws AAIException { + AAIConfig.get("aai.response.null"); + } + + @Test + public void testGetStringReloadConfig() throws AAIException { + String res = AAIConfig.get("aai.config.nodename"); + assertNotNull(res); + assertEquals(AAIConfig.getNodeName(), res); + } + + @Test + public void testGetServerProps() { + Properties res = AAIConfig.getServerProps(); + assertNotNull(res); + } + + @Test + public void testGetNodeName() throws UnknownHostException { + InetAddress ip = InetAddress.getLocalHost(); + String res = AAIConfig.getNodeName(); + assertNotNull(res); + assertEquals(ip.getHostName(), res); + } + + @Test + public void testIsEmpty() { + boolean res = AAIConfig.isEmpty("hllo world"); + assertFalse(res); + } + + @Test + public void testIsEmptyEmpty() { + boolean res = AAIConfig.isEmpty(""); + assertTrue(res); + } + + @Test + public void testIsEmptyNull() { + boolean res = AAIConfig.isEmpty(null); + assertTrue(res); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/AutoGenerateHtmlTest.java b/aai-core/src/test/java/org/onap/aai/util/AutoGenerateHtmlTest.java new file mode 100644 index 00000000..f2f9f61a --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/AutoGenerateHtmlTest.java @@ -0,0 +1,35 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util; + +import java.io.IOException; + +import org.junit.Test; + +import freemarker.template.TemplateException; + +public class AutoGenerateHtmlTest { + + @Test(expected=NullPointerException.class) + public void testMain() throws IOException, TemplateException { + AutoGenerateHtml.main(new String[] {}); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/GenerateXsdTest.java b/aai-core/src/test/java/org/onap/aai/util/GenerateXsdTest.java index 6fa55559..f8ede632 100644 --- a/aai-core/src/test/java/org/onap/aai/util/GenerateXsdTest.java +++ b/aai-core/src/test/java/org/onap/aai/util/GenerateXsdTest.java @@ -19,271 +19,81 @@ */ package org.onap.aai.util; +import static org.hamcrest.CoreMatchers.is; import static org.junit.Assert.*; -import java.io.StringReader; - -import javax.xml.XMLConstants; -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; +import java.io.File; import org.hamcrest.CoreMatchers; -import org.junit.Assert; import org.junit.Before; -import org.junit.Rule; import org.junit.Test; -import org.junit.runner.RunWith; - -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.NodeList; -import org.xml.sax.InputSource; import org.onap.aai.introspection.Version; +import org.onap.aai.util.genxsd.HTMLfromOXM; +import org.onap.aai.util.genxsd.HTMLfromOXMTest; +import org.onap.aai.util.genxsd.XSDElementTest; +import org.onap.aai.util.genxsd.YAMLfromOXM; +import org.onap.aai.util.genxsd.YAMLfromOXMTest; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class GenerateXsdTest { - private static final int maxSizeForXml = 20000; - private String testXML; + private static final Logger logger = LoggerFactory.getLogger("GenerateXsd.class"); + private String testXML; @Before public void setUp() throws Exception { //PowerMockito.mockStatic(GenerateXsd.class); - StringBuilder sb = new StringBuilder(maxSizeForXml); - addNamespace(sb); - addRelationshipList(sb); - addRelationship(sb); - addRelatedToProperty(sb); - addRelationshipData(sb); - addBusiness(sb); - addCustomers(sb); - addCustomer(sb); - addServiceSubscriptions(sb); - addServiceSubscription(sb); - addEndOfXML(sb); - testXML = sb.toString(); - } - - private void addNamespace(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addRelationshipList(StringBuilder sb ) { - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("/n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addRelationship(StringBuilder sb ) { - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append(""); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addRelatedToProperty(StringBuilder sb) { - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); + XSDElementTest x = new XSDElementTest(); + x.setUp(); + testXML = x.getTestXML(); } - private void addRelationshipData(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addBusiness(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addCustomers(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addCustomer(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addServiceSubscriptions(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - private void addServiceSubscription(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - sb.append("\n"); - } - - private void addEndOfXML(StringBuilder sb){ - sb.append("\n"); - sb.append("\n"); - } - - @Test - public void test_processOxmFile() { + public void test_generateSwaggerFromOxmFile( ) { + Version v = Version.v11; + String apiVersion = v.toString(); + String fileContent = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + fileContent = swagger.process(); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug(fileContent); + assertThat(fileContent, is(new YAMLfromOXMTest().YAMLresult())); + } - - GenerateXsd generateXsd = new GenerateXsd(); - - //GenerateXsd generateXsdSpy = PowerMockito.spy(generateXsd); - - //generateXsdSpy.processOxmFile(null, Version.getLatest(), testXML); - - String xsdResult = generateXsd.processOxmFile(null, Version.getLatest(), testXML); + @Test + public void test_generateXSDFromOxmFile( ) { - String relationshipListExpected = " \n \n \n \n \n \n "; - String relatedToPropertyExpected = " \n \n \n \n \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Key part of a key/value pair\")\r\n \r\n \r\n \n" - + " \n \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Value part of a key/value pair\")\r\n \r\n \r\n \n \n \n "; - assertNotNull(xsdResult); + Version v = Version.v11; + String fileContent = null; + try { + HTMLfromOXM xsd = new HTMLfromOXM(testXML, v); + fileContent = xsd.process(); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug(fileContent); + assertThat(fileContent, is(new HTMLfromOXMTest().HTMLresult())); } + @Test - public void test_generateSwaggerFromOxmFile( ) { - + public void testGetAPIVersion() { + GenerateXsd.apiVersion=Version.v11.name(); + assertThat(GenerateXsd.getAPIVersion(),is("v11")); + } - GenerateXsd generateXsd = new GenerateXsd(); + @Test + public void testGetYamlDir() { + assertThat(GenerateXsd.getYamlDir(),is("../aai-schema/src/main/resources/aai_swagger_yaml")); + } - String customerOperation = " /business/customers/customer/{global-customer-id}:\n get:\n tags:\n - Business\n summary: returns customer"; - String relationshipListDefinition = " relationship-list:\n properties:\n relationship:\n type: array\n items: \n $ref: \"#/definitions/relationship\""; - String swaggerResult = generateXsd.generateSwaggerFromOxmFile(null, testXML); - assertNotNull(swaggerResult); + @Test + public void testGetResponsesUrl() { + assertNull(GenerateXsd.getResponsesUrl()); } } diff --git a/aai-core/src/test/java/org/onap/aai/util/JettyObfuscationConversionCommandLineUtilTest.java b/aai-core/src/test/java/org/onap/aai/util/JettyObfuscationConversionCommandLineUtilTest.java new file mode 100644 index 00000000..d9fd1d6b --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/JettyObfuscationConversionCommandLineUtilTest.java @@ -0,0 +1,71 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertTrue; + +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.junit.Test; +import org.onap.aai.restcore.JettyObfuscationConversionCommandLineUtil; + +public class JettyObfuscationConversionCommandLineUtilTest { + + private final ByteArrayOutputStream testOut = new ByteArrayOutputStream(); + + /** + * Test. + */ + @Test + public void test() { + //setup, this will catch main's print statements for evaluation + System.setOut(new PrintStream(testOut)); + + /* ------ TEST OBFUSCATION ----*/ + JettyObfuscationConversionCommandLineUtil.main(new String[]{"-e", "hello world"}); + /* + * testOut was also catching any logging statements which interfered with result checking. + * This regex business was the workaround - it tries to find the expected value in + * the results and asserts against that. + */ + String obfResult = testOut.toString(); + String obfExpected = "OBF:1thf1ugo1x151wfw1ylz11tr1ymf1wg21x1h1uh21th7"; + Pattern obfExpectPat = Pattern.compile(obfExpected); + Matcher obfMatch = obfExpectPat.matcher(obfResult); + assertTrue(obfMatch.find()); + + testOut.reset(); //clear out previous result + + /* ------ TEST DEOBFUSCATION ----- */ + JettyObfuscationConversionCommandLineUtil.main(new String[]{"-d", obfExpected}); + String deobfResult = testOut.toString(); + String deobfExpected = "hello world"; + Pattern deobfExpectPat = Pattern.compile(deobfExpected); + Matcher deobfMatch = deobfExpectPat.matcher(deobfResult); + assertTrue(deobfMatch.find()); + + //clean up, resets to stdout + System.setOut(null); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java b/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java index 5bd7984a..d3725f48 100644 --- a/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java +++ b/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java @@ -112,7 +112,7 @@ public class StoreNotificationEventTest extends AAISetup { eh.setSourceName("source"); eh.setSequenceNumber("23"); eh.setSeverity("ALERT"); - eh.setVersion("v11"); + eh.setVersion("v12"); String res = sne.storeEvent(eh, object); @@ -126,7 +126,7 @@ public class StoreNotificationEventTest extends AAISetup { assertTrue(res.contains("\"sequence-number\" : \"23\"")); assertTrue(res.contains("\"severity\" : \"ALERT\"")); assertTrue(res.contains("\"event-type\" : \"surprise\"")); - assertTrue(res.contains("\"version\" : \"v11\"")); + assertTrue(res.contains("\"version\" : \"v12\"")); assertTrue(res.contains("\"action\" : \"action!\"")); assertTrue(res.contains("\"entity-link\" : \"entity-link\"")); assertTrue(res.contains("\"entity\"")); @@ -140,20 +140,20 @@ public class StoreNotificationEventTest extends AAISetup { public void testStoreDynamicEventNullObj() throws AAIException { DynamicEntity eventHeader = Mockito.mock(DynamicEntity.class); DynamicJAXBContext notificationJaxbContext = Mockito.mock(DynamicJAXBContext.class); - sne.storeDynamicEvent(notificationJaxbContext, "v11", eventHeader, null); + sne.storeDynamicEvent(notificationJaxbContext, "v12", eventHeader, null); } - @Test(expected = AAIException.class) + @Test(expected = Exception.class) public void testStoreDynamicEventAAIException() throws Exception { DynamicEntity eventHeader = Mockito.mock(DynamicEntity.class); DynamicEntity obj = Mockito.mock(DynamicEntity.class); DynamicJAXBContext notificationJaxbContext = Mockito.mock(DynamicJAXBContext.class); ClassLoader cl = getClass().getClassLoader(); - InputStream is = cl.getResourceAsStream("oxm/aai_oxm_v11.xml"); + InputStream is = cl.getResourceAsStream("oxm/aai_oxm_v12.xml"); Map properties = new HashMap(); properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, is); DynamicJAXBContext notificationJaxbContextReal = DynamicJAXBContextFactory.createContextFromOXM(cl, properties); - DynamicType dtReal = notificationJaxbContextReal.getDynamicType("inventory.aai.onap.org.v11.NotificationEvent"); + DynamicType dtReal = notificationJaxbContextReal.getDynamicType("inventory.aai.onap.org.v12.NotificationEvent"); DynamicType dt = Mockito.mock(DynamicType.class); DynamicEntity notificationEventReal = dtReal.newDynamicEntity(); JAXBMarshaller marshaller = Mockito.mock(JAXBMarshaller.class); @@ -163,7 +163,7 @@ public class StoreNotificationEventTest extends AAISetup { Mockito.when(notificationJaxbContext.createMarshaller()).thenReturn(marshaller); Mockito.doNothing().when(marshaller).marshal(Mockito.any(DynamicJAXBContext.class), Mockito.any(StringWriter.class)); - sne.storeDynamicEvent(notificationJaxbContext, "v11", eventHeader, obj); + sne.storeDynamicEvent(notificationJaxbContext, "v12", eventHeader, obj); } @Test(expected = AAIException.class) @@ -174,7 +174,7 @@ public class StoreNotificationEventTest extends AAISetup { @Test public void testStoreEventIntrospector() throws Exception { - Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v12); Introspector eventHeader = loader.introspectorFromName("notification-event-header"); eventHeader.setValue("id", "123"); eventHeader.setValue("timestamp", "current-time"); @@ -185,7 +185,7 @@ public class StoreNotificationEventTest extends AAISetup { eventHeader.setValue("source-name", "source"); eventHeader.setValue("sequence-number", "23"); eventHeader.setValue("severity", "ALERT"); - eventHeader.setValue("version", "v11"); + eventHeader.setValue("version", "v12"); Introspector obj = loader.introspectorFromName("notification-event"); @@ -201,7 +201,7 @@ public class StoreNotificationEventTest extends AAISetup { assertTrue(res.contains("\"sequence-number\":\"23\"")); assertTrue(res.contains("\"severity\":\"ALERT\"")); assertTrue(res.contains("\"event-type\":\"surprise\"")); - assertTrue(res.contains("\"version\":\"v11\"")); + assertTrue(res.contains("\"version\":\"v12\"")); assertTrue(res.contains("\"action\":\"action!\"")); assertTrue(res.contains("\"entity-link\":\"entity-link\"")); assertTrue(res.contains("\"notification-event\"")); @@ -209,7 +209,7 @@ public class StoreNotificationEventTest extends AAISetup { @Test public void testStoreEventIntrospectorEmptyEventHeader() throws Exception { - Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v12); Introspector eventHeader = loader.introspectorFromName("notification-event-header"); Introspector obj = loader.introspectorFromName("notification-event"); diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteFootnoteSetTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteFootnoteSetTest.java new file mode 100644 index 00000000..3c1e825d --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteFootnoteSetTest.java @@ -0,0 +1,83 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Arrays; +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@RunWith(Parameterized.class) +public class DeleteFootnoteSetTest { + String targetNode; + String flavor; + String result; + DeleteFootnoteSet footnotes = null; + + @Parameters + public static Collection testConditions() { + String inputs [][] = { + {"vserver","(1)", "\n -(1) IF this VSERVER node is deleted, this FROM node is DELETED also\n"}, + {"ctag-pool","(2)", "\n -(2) IF this CTAG-POOL node is deleted, this TO node is DELETED also\n"}, + {"pserver","(3)", "\n -(3) IF this FROM node is deleted, this PSERVER is DELETED also\n"}, + {"oam-network","(4)", "\n -(4) IF this TO node is deleted, this OAM-NETWORK is DELETED also\n"}, + {"dvs-switch","(1)", "\n -(1) IF this DVS-SWITCH node is deleted, this FROM node is DELETED also\n"}, + {"availability-zone","(3)", "\n -(3) IF this FROM node is deleted, this AVAILABILITY-ZONE is DELETED also\n"} + }; + return (Arrays.asList(inputs)); + } + + public DeleteFootnoteSetTest(String targetNode, String flavor, String result) { + super(); + this.targetNode = targetNode; + this.flavor = flavor; + this.result=result; + } + + @Before + public void setUp() throws Exception { + footnotes = new DeleteFootnoteSet(this.targetNode); + } + + @Test + public void testDeleteFootnoteSet() { + assertThat(footnotes.targetNode, is(this.targetNode)); + } + + @Test + public void testAdd() { + footnotes.add(this.flavor); + assertThat(footnotes.footnotes.size(), is(1)); + } + + @Test + public void testToString() { + footnotes.add(this.flavor); + assertThat(footnotes.toString(), is(this.result)); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteOperationTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteOperationTest.java new file mode 100644 index 00000000..501babe3 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/DeleteOperationTest.java @@ -0,0 +1,82 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Arrays; +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +@RunWith(Parameterized.class) +public class DeleteOperationTest { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private String result; + + @Parameters + public static Collection testConditions() { + String inputs [][] = { + {"NetworkGenericVnfsGenericVnf","generic-vnf","Network","/network/generic-vnfs/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__\n"," delete:\n tags:\n - Network\n summary: delete an existing generic-vnf\n description: delete an existing generic-vnf\n operationId: deleteNetworkGenericVnfsGenericVnf\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__\n - name: resource-version\n in: query\n description: resource-version for concurrency\n required: true\n type: string\n"}, + {"CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver","vserver","CloudInfrastructure","/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}"," - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__\n"," delete:\n tags:\n - CloudInfrastructure\n summary: delete an existing vserver\n description: delete an existing vserver\n operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__\n - name: resource-version\n in: query\n description: resource-version for concurrency\n required: true\n type: string\n"}, +// if ( StringUtils.isEmpty(tag) ) + {"GenericVnf","generic-vnf","","/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__\n",""}, +// Test: if ( !path.endsWith("/relationship") && !path.endsWith("}") ) + {"CloudInfrastructurePserversPserverPInterfaces","p-interfaces","CloudInfrastructure","/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces"," - name: hostname\n in: path\n description: Value from executing hostname on the compute node.\n required: true\n type: string\n example: __HOSTNAME__",""}, +// {"","ctag-pool","","","",""}, +// {"","pserver","","","",""}, +// {"","oam-network","","","",""}, +// {"","dvs-switch","","","",""}, +// {"","availability-zone","","","",""} + }; + return Arrays.asList(inputs); + } + + public DeleteOperationTest(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, String result) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams=pathParams; + this.result = result; + } + @BeforeClass + public static void setUpBeforeClass() throws Exception { + + } + + @Test + public void testToString() { + DeleteOperation delete = new DeleteOperation(useOpId, xmlRootElementName, tag, path, pathParams); + String modResult = delete.toString(); + assertThat(modResult, is(this.result)); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeDescriptionTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeDescriptionTest.java new file mode 100644 index 00000000..d57dc4aa --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeDescriptionTest.java @@ -0,0 +1,392 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.*; +import static org.junit.Assert.assertThat; + +public class EdgeDescriptionTest { + private DocumentContext jsonContext; + private EdgeRuleSet edgeSet; + private Collectionedges; + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + + } + + @Before + public void setUp() throws Exception { + String json = "{" + + " \"rules\": [" + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"complex\"," + + " \"label\": \"org.onap.relationships.inventory.LocatedIn\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"this description\"" + + " }," +/* + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"service-capability\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"cloud-region\"," + + " \"label\": \"org.onap.relationships.inventory.BelongsTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"!${direction}\"," + + " \"delete-other-v\": \"!${direction}\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"NONE\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"ctag-pool\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"dvs-switch\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"generic-vnf\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"pserver\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.MemberOf\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"vce\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," +*/ + + " ]}"; + jsonContext = JsonPath.parse(json); + this.edgeSet = new EdgeRuleSet(jsonContext); + String nodeName = "availability-zone"; + edges = edgeSet.getEdgeRules(nodeName); + } + + @Test + public void testGetDeleteOtherV() { + String target = "availability-zone"+"|"+"complex"+"-"+"NONE"; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getDeleteOtherV(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetDeleteOtherV() { + String target = "availability-zone"+"|"+"complex"+"-"+"IN"; + for (EdgeDescription ed : edges) { + ed.setDeleteOtherV("IN"); + String modResult = ed.getRuleKey() + "-" + ed.getDeleteOtherV(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetPreventDelete() { + String target = "availability-zone"+"|"+"complex"+"-"+"IN"; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getPreventDelete(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetPreventDelete() { + for (EdgeDescription ed : edges) { + String target = "availability-zone"+"|"+"complex"+"-"+"OUT"; + ed.setPreventDelete("OUT"); + String modResult = ed.getRuleKey() + "-" + ed.getPreventDelete(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetAlsoDeleteFootnote() { + String target = "availability-zone"+"|"+"complex"+"-"+""; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getAlsoDeleteFootnote(ed.getFrom()); + assertThat(modResult, is(target)); + ed.setDeleteOtherV("IN"); + target = "availability-zone"+"|"+"complex"+"-"+"(4)"; + modResult = ed.getRuleKey() + "-" + ed.getAlsoDeleteFootnote(ed.getFrom()); + assertThat(modResult, is(target)); + target = "availability-zone"+"|"+"complex"+"-"+"(1)"; + modResult = ed.getRuleKey() + "-" + ed.getAlsoDeleteFootnote(ed.getTo()); + assertThat(modResult, is(target)); + ed.setDeleteOtherV("OUT"); + target = "availability-zone"+"|"+"complex"+"-"+"(2)"; + modResult = ed.getRuleKey() + "-" + ed.getAlsoDeleteFootnote(ed.getFrom()); + assertThat(modResult, is(target)); + target = "availability-zone"+"|"+"complex"+"-"+"(3)"; + modResult = ed.getRuleKey() + "-" + ed.getAlsoDeleteFootnote(ed.getTo()); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetTo() { + String target = "availability-zone"+"|"+"complex"+"-"+"complex"; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getTo(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetTo() { + String target = "availability-zone"+"|"+"complex"+"-"+"jazz"; + for (EdgeDescription ed : edges) { + ed.setTo("jazz"); + String modResult = ed.getRuleKey() + "-" + ed.getTo(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetFrom() { + String target = "availability-zone"+"|"+"complex"+"-"+"availability-zone"; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getFrom(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetFrom() { + String target = "availability-zone"+"|"+"complex"+"-"+"jazz"; + for (EdgeDescription ed : edges) { + ed.setFrom("jazz"); + String modResult = ed.getRuleKey() + "-" + ed.getFrom(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetRuleKey() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo(); + String modResult = ed.getRuleKey(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetMultiplicity() { + String target = "availability-zone"+"|"+"complex"+"-"+"MANY2ONE"; + for (EdgeDescription ed : edges) { + String modResult = ed.getRuleKey() + "-" + ed.getMultiplicity(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetDirection() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"OUT"; + String modResult = ed.getRuleKey() + "-" + ed.getDirection(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetDescription() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"this description"; + String modResult = ed.getRuleKey() + "-" + ed.getDescription(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetRuleKey() { + for (EdgeDescription ed : edges) { + ed.setRuleKey("A|B"); + String target = "A|B"; + String modResult = ed.getRuleKey(); + assertThat(modResult, is(target)); + } } + + @Test + public void testSetType() { + String target = "availability-zone"+"|"+"complex"+"-"+"CHILD"; + for (EdgeDescription ed : edges) { + ed.setType(EdgeDescription.LineageType.CHILD); + String modResult = ed.getRuleKey() + "-" + ed.getType(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetDirection() { + String target = "availability-zone"+"|"+"complex"+"-"+"IN"; + for (EdgeDescription ed : edges) { + ed.setDirection("IN"); + String modResult = ed.getRuleKey() + "-" + ed.getDirection(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetMultiplicity() { + String target = "availability-zone"+"|"+"complex"+"-"+"ONE2MANY"; + for (EdgeDescription ed : edges) { + ed.setTo("ONE2MANY"); + String modResult = ed.getRuleKey() + "-" + ed.getTo(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetDescription() { + for (EdgeDescription ed : edges) { + ed.setDescription("a new description"); + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"a new description"; + String modResult = ed.getRuleKey() + "-" + ed.getDescription(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetRelationshipDescription() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"( availability-zone LocatedIn complex, MANY2ONE)\n this description"; + String modResult = ed.getRuleKey() + "-" + ed.getRelationshipDescription("FROM",ed.getTo()); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetType() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"UNRELATED"; + String modResult = ed.getRuleKey() + "-" + ed.getType(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetLabel() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"org.onap.relationships.inventory.LocatedIn"; + String modResult = ed.getRuleKey() + "-" + ed.getLabel(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testGetShortLabel() { + for (EdgeDescription ed : edges) { + String target = ed.getFrom()+"|"+ed.getTo()+"-"+"LocatedIn"; + String modResult = ed.getRuleKey() + "-" + ed.getShortLabel(); + assertThat(modResult, is(target)); + } + } + + @Test + public void testSetLabel() { + String newLabel = "New label"; + for (EdgeDescription ed : edges) { + ed.setLabel(newLabel); + String target = ed.getFrom()+"|"+ed.getTo()+"-"+newLabel; + String modResult = ed.getRuleKey() + "-" + ed.getLabel(); + assertThat(modResult, not(equalTo("org.onap.relationships.inventory.LocatedIn"))); + assertThat(modResult, is(target)); + } + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeRuleSetTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeRuleSetTest.java new file mode 100644 index 00000000..3668cf36 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/EdgeRuleSetTest.java @@ -0,0 +1,243 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileWriter; +import java.io.IOException; +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class EdgeRuleSetTest { + private static File edgesFile = new File("edges.json"); + private static String nodeName = "availability-zone"; + private DocumentContext jsonContext; + private String json; + private EdgeRuleSet edgeSet; + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + json = "{" + + " \"rules\": [" + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"complex\"," + + " \"label\": \"org.onap.relationships.inventory.LocatedIn\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"this description\"" + + " }," + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"service-capability\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"cloud-region\"," + + " \"label\": \"org.onap.relationships.inventory.BelongsTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"!${direction}\"," + + " \"delete-other-v\": \"!${direction}\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"NONE\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"ctag-pool\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"dvs-switch\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"generic-vnf\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"vf-module\"," + + " \"to\": \"vnfc\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"ONE2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"pserver\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.MemberOf\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"vce\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " ]}"; + FileWriter file = new FileWriter(edgesFile); + file.write(json); + file.flush(); + file.close(); + jsonContext = JsonPath.parse(json); + + } + + @Test + public void testEdgeRuleSetFile() throws FileNotFoundException, IOException { + this.edgeSet = new EdgeRuleSet(edgesFile); + Collectionedges = edgeSet.getEdgeRules(nodeName); + assertThat(edges.size(), is(8)); + } + + @Test + public void testEdgeRuleSetDocumentContext() { + this.edgeSet = new EdgeRuleSet(jsonContext); + Collectionedges = edgeSet.getEdgeRules(nodeName); + assertThat(edges.size(), is(8)); + } + + @Test + public void testGetEdgeRules() { + this.edgeSet = new EdgeRuleSet(jsonContext); + Collectionedges = edgeSet.getEdgeRules(nodeName); + assertThat(edges.size(), is(8)); + } + + @Test + public void testGetEdgeRulesTO() { + this.edgeSet = new EdgeRuleSet(jsonContext); + Collectionedges = edgeSet.getEdgeRulesTO(nodeName); + assertThat(edges.size(), is(5)); + } + + @Test + public void testGetEdgeRulesFROM() { + this.edgeSet = new EdgeRuleSet(jsonContext); + Collectionedges = edgeSet.getEdgeRulesFROM(nodeName); + assertThat(edges.size(), is(3)); + } + + @Test + public void testGetEdgeRulesFromJson() { + String fromRulesPath = "$['rules'][?(@['from']=='" + nodeName + "')]"; + this.edgeSet = new EdgeRuleSet(jsonContext); + Collection edges = edgeSet.getEdgeRulesFromJson( fromRulesPath, true ); + assertThat(edges.size(), is(3)); + } + + @Test + public void testPreventDeleteRules() { + String target = "AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE\n"; + this.edgeSet = new EdgeRuleSet(jsonContext); + String fromDeleteRules = edgeSet.preventDeleteRules(nodeName); + assertThat(fromDeleteRules, is(target)); + } + + @Test + public void testFromDeleteRules() { + String target = "VF-MODULE cannot be deleted if related to VNFC\n"; + this.edgeSet = new EdgeRuleSet(jsonContext); + String fromDeleteRules = edgeSet.fromDeleteRules("vf-module"); + assertThat(fromDeleteRules, is(target)); + } + + @After + public void tearDown() throws Exception { + edgesFile.delete(); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/GetOperationTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/GetOperationTest.java new file mode 100644 index 00000000..79a243d9 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/GetOperationTest.java @@ -0,0 +1,107 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Arrays; +import java.util.Collection; +import java.util.Vector; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +@RunWith(Parameterized.class) +public class GetOperationTest { + private static final Logger logger = LoggerFactory.getLogger("GetOperationTest.class"); + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private String result; + + @Parameters + public static Collection testConditions() { + String inputs [][] = { + {"NetworkGenericVnfsGenericVnf","generic-vnf","Network","/network/generic-vnfs/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__"," /network/generic-vnfs/generic-vnf/{vnf-id}:\n get:\n tags:\n - Network\n summary: returns generic-vnf\n description: returns generic-vnf\n operationId: getNetworkGenericVnfsGenericVnf\n produces:\n - application/json\n - application/xml\n responses:\n \"200\":\n description: successful operation\n schema:\n $ref: \"#/getDefinitions/generic-vnf\"\n \"default\":\n null parameters:\n - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__"}, + {"CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver","vserver","CloudInfrastructure","/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}"," - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__"," /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:\n get:\n tags:\n - CloudInfrastructure\n summary: returns vserver\n description: returns vserver\n operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver\n produces:\n - application/json\n - application/xml\n responses:\n \"200\":\n description: successful operation\n schema:\n $ref: \"#/getDefinitions/vserver\"\n \"default\":\n null parameters:\n - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__"}, + {"GenericVnf","generic-vnf","","/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__",""}, + {"CloudInfrastructurePserversPserverPInterfaces","p-interfaces","CloudInfrastructure","/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces"," - name: hostname\n in: path\n description: Value from executing hostname on the compute node.\n required: true\n type: string\n example: __HOSTNAME__"," /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:\n get:\n tags:\n - CloudInfrastructure\n summary: returns p-interfaces\n description: returns p-interfaces\n operationId: getCloudInfrastructurePserversPserverPInterfaces\n produces:\n - application/json\n - application/xml\n responses:\n \"200\":\n description: successful operation\n schema:\n $ref: \"#/getDefinitions/p-interfaces\"\n \"default\":\n null parameters:\n - name: hostname\n in: path\n description: Value from executing hostname on the compute node.\n required: true\n type: string\n example: __HOSTNAME__ - name: interface-name\n in: query\n description:\n required: false\n type: string - name: prov-status\n in: query\n description:\n required: false\n type: string"}, + // {"","ctag-pool","","","",""}, +// {"","pserver","","","",""}, +// {"","oam-network","","","",""}, +// {"","dvs-switch","","","",""}, +// {"","availability-zone","","","",""} + }; + return Arrays.asList(inputs); + } + + public GetOperationTest(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, String result) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams=pathParams; + this.result = result; + } + @BeforeClass + public static void setUpBeforeClass() throws Exception { + String container = "p-interfaces"; + String queryProps[] = { + " - name: interface-name\n in: query\n description:\n required: false\n type: string", + " - name: prov-status\n in: query\n description:\n required: false\n type: string" + }; + Vector containerProps = new Vector(); + for(String prop : queryProps) { + containerProps.add(prop); + } + GetOperation.addContainerProps(container, containerProps); + } + + @Test + public void testAddContainerProps() { + String container = this.xmlRootElementName; + String prop = " - name: "+container+"\n in: query\n description:\n required: false\n type: string"; + Vector queryProps = new Vector(); + queryProps.add(prop); + for(String p : queryProps) { + logger.debug("qProp="+p); + } + logger.debug("Done="+this.xmlRootElementName); + GetOperation.addContainerProps(container, queryProps); + assertThat(GetOperation.containers.get(container).get(0), is(prop)); + } + + @Test + public void testToString() { + GetOperation get = new GetOperation(useOpId, xmlRootElementName, tag, path, pathParams); + String modResult = get.toString(); + assertThat(modResult, is(this.result)); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/HTMLfromOXMTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/HTMLfromOXMTest.java new file mode 100644 index 00000000..a3cba5eb --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/HTMLfromOXMTest.java @@ -0,0 +1,278 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.aai.introspection.Version; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Element; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +public class HTMLfromOXMTest { + private static final Logger logger = LoggerFactory.getLogger("HTMLfromOXMTest.class"); + private String testXML; + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + XSDElementTest x = new XSDElementTest(); + x.setUp(); + testXML = x.testXML; + } + + @Test + public void testGetDocumentHeader() { + Version v = Version.v11; + String header = null; + try { + HTMLfromOXM swagger = new HTMLfromOXM(testXML, v); + header = swagger.getDocumentHeader(); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug("Header:"); + logger.debug(header); + assertThat(header, is(HTMLheader())); + } + + @Test + public void testProcess() { + Version v = Version.v11; + String fileContent = null; + try { + HTMLfromOXM xsd = new HTMLfromOXM(testXML, v); + fileContent = xsd.process(); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug("FileContent-I:"); + logger.debug(fileContent); + assertThat(fileContent, is(HTMLresult())); + } + + @Test + public void testHTMLfromOXMFileVersion() throws IOException { + String outfileName = "testXML.xml"; + File XMLfile = new File(outfileName); + XMLfile.createNewFile(); + BufferedWriter bw = null; + Charset charset = Charset.forName("UTF-8"); + Path path = Paths.get(outfileName); + bw = Files.newBufferedWriter(path, charset); + bw.write(testXML); + bw.close(); + Version v = Version.v11; + String fileContent = null; + try { + HTMLfromOXM xsd = new HTMLfromOXM(testXML, v); + fileContent = xsd.process(); + } catch(Exception e) { + e.printStackTrace(); + } + XMLfile.delete(); + logger.debug("FileContent-I:"); + logger.debug(fileContent); + assertThat(fileContent, is(HTMLresult())); + } + + @Test + public void testHTMLfromOXMStringVersion() { + Version v = Version.v11; + String fileContent = null; + try { + HTMLfromOXM xsd = new HTMLfromOXM(testXML, v); + fileContent = xsd.process(); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug("FileContent-II:"); + logger.debug(fileContent); + assertThat(fileContent, is(HTMLresult())); + } + + @Test + public void testProcessJavaTypeElement() { + String target = "Element=java-type/Customer"; + Version v = Version.v11; + Element customer = null; + try { + HTMLfromOXM xsd = new HTMLfromOXM(testXML, v); + xsd.process(); + customer = xsd.getJavaTypeElementSwagger("Customer"); + } catch(Exception e) { + e.printStackTrace(); + } + logger.debug("Element:"); + logger.debug("Element="+customer.getNodeName()+"/"+customer.getAttribute("name")); + assertThat("Element="+customer.getNodeName()+"/"+customer.getAttribute("name"), is(target)); } + + public String HTMLresult() { + StringBuilder sb = new StringBuilder(32368); + sb.append(HTMLheader()); + sb.append(HTMLdefs()); + return sb.toString(); + } + + public String HTMLheader() { + StringBuilder sb = new StringBuilder(1500); + sb.append("\n"); + sb.append("\n\n"); + return sb.toString(); + } + public String HTMLdefs() { + StringBuilder sb = new StringBuilder(1500); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Object that group service instances.\",indexedProps=\"service-type\",dependentOn=\"customer\",container=\"service-subscriptions\",crossEntityReference=\"service-instance,service-type\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(isKey=true,description=\"Value defined by orchestration to identify this service across ECOMP.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"This property will be deleted from A&AI in the near future. Only stop gap solution.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Used for optimistic concurrency. Must be empty on create, valid on update and delete.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Collection of objects that group service instances.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"customer identifiers to provide linkage back to BSS information.\",nameProps=\"subscriber-name\",indexedProps=\"subscriber-name,global-customer-id,subscriber-type\",searchable=\"global-customer-id,subscriber-name\",uniqueProps=\"global-customer-id\",container=\"customers\",namespace=\"business\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(isKey=true,description=\"Global customer id used across ECOMP to uniquely identify customer.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Subscriber name, an alternate way to retrieve a customer.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Subscriber type, a way to provide VID with only the INFRA customers.\",defaultValue=\"CUST\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Used for optimistic concurrency. Must be empty on create, valid on update and delete.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Collection of customer identifiers to provide linkage back to BSS information.\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" @org.onap.aai.annotations.Metadata(description=\"Namespace for business related constructs\")\r\n"); + sb.append(" \r\n"); + sb.append(" \r\n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append(" \n"); + sb.append("\n"); + return sb.toString(); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/PatchOperationTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/PatchOperationTest.java new file mode 100644 index 00000000..7bfaebf5 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/PatchOperationTest.java @@ -0,0 +1,82 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Arrays; +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +@RunWith(Parameterized.class) +public class PatchOperationTest { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private String result; + + @Parameters + public static Collection testConditions() { + String inputs [][] = { + {"NetworkGenericVnfsGenericVnf","generic-vnf","Network","/network/generic-vnfs/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__"," patch:\n tags:\n - Network\n summary: update an existing generic-vnf\n description: |\n Update an existing generic-vnf\n #\n Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n The PUT operation will entirely replace an existing object.\n The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n #\n Other differences between PUT and PATCH are:\n #\n - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n operationId: UpdateNetworkGenericVnfsGenericVnf\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__ - name: body\n in: body\n description: generic-vnf object that needs to be updated.\n required: true\n schema:\n $ref: \"#/patchDefinitions/generic-vnf\"\n"}, + {"CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver","vserver","CloudInfrastructure","/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}"," - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__"," patch:\n tags:\n - CloudInfrastructure\n summary: update an existing vserver\n description: |\n Update an existing vserver\n #\n Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n The PUT operation will entirely replace an existing object.\n The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n #\n Other differences between PUT and PATCH are:\n #\n - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__ - name: body\n in: body\n description: vserver object that needs to be updated.\n required: true\n schema:\n $ref: \"#/patchDefinitions/vserver\"\n"}, +// if ( StringUtils.isEmpty(tag) ) + {"GenericVnf","generic-vnf","","/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__",""}, +// Test: if ( !path.endsWith("/relationship") && !path.endsWith("}") ) + {"CloudInfrastructurePserversPserverPInterfaces","p-interfaces","CloudInfrastructure","/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces"," - name: hostname\n in: path\n description: Value from executing hostname on the compute node.\n required: true\n type: string\n example: __HOSTNAME__",""}, + // {"","ctag-pool","","","",""}, +// {"","pserver","","","",""}, +// {"","oam-network","","","",""}, +// {"","dvs-switch","","","",""}, +// {"","availability-zone","","","",""} + }; + return Arrays.asList(inputs); + } + + public PatchOperationTest(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, String result) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams=pathParams; + this.result = result; + } + @BeforeClass + public static void setUpBeforeClass() throws Exception { + + } + + @Test + public void testToString() { + PatchOperation patch = new PatchOperation(useOpId, xmlRootElementName, tag, path, pathParams); + String modResult = patch.toString(); + assertThat(modResult, is(this.result)); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/PutOperationTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/PutOperationTest.java new file mode 100644 index 00000000..b7cced06 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/PutOperationTest.java @@ -0,0 +1,84 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; +import org.onap.aai.introspection.Version; + +import java.util.Arrays; +import java.util.Collection; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +@RunWith(Parameterized.class) +public class PutOperationTest { + private String useOpId; + private String xmlRootElementName; + private String tag; + private String path; + private String pathParams; + private String result; + private static Version v = Version.getLatest(); + + @Parameters + public static Collection testConditions() { + String inputs [][] = { + {"NetworkGenericVnfsGenericVnf","generic-vnf","Network","/network/generic-vnfs/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__"," put:\n tags:\n - Network\n summary: create or update an existing generic-vnf\n description: |\n Create or update an existing generic-vnf.\n #\n Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n operationId: createOrUpdateNetworkGenericVnfsGenericVnf\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__ - name: body\n in: body\n description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/"+v.name()+"/NetworkGenericVnfsGenericVnf.json)\n required: true\n schema:\n $ref: \"#/definitions/generic-vnf\"\n"}, + {"CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver","vserver","CloudInfrastructure","/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}"," - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__"," put:\n tags:\n - CloudInfrastructure\n summary: create or update an existing vserver\n description: |\n Create or update an existing vserver.\n #\n Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver\n consumes:\n - application/json\n - application/xml\n produces:\n - application/json\n - application/xml\n responses:\n \"default\":\n null parameters:\n - name: cloud-owner\n in: path\n description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname\n required: true\n type: string\n example: __CLOUD-OWNER__\n - name: cloud-region-id\n in: path\n description: Identifier used by the vendor for the region. Second part of composite key\n required: true\n type: string\n example: __CLOUD-REGION-ID__\n - name: tenant-id\n in: path\n description: Unique id relative to the cloud-region.\n required: true\n type: string\n example: __TENANT-ID__\n - name: vserver-id\n in: path\n description: Unique identifier for this vserver relative to its tenant\n required: true\n type: string\n example: __VSERVER-ID__ - name: body\n in: body\n description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/"+v.name()+"/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)\n required: true\n schema:\n $ref: \"#/definitions/vserver\"\n"}, +// if ( StringUtils.isEmpty(tag) ) + {"GenericVnf","generic-vnf","","/generic-vnf/{vnf-id}"," - name: vnf-id\n in: path\n description: Unique id of VNF. This is unique across the graph.\n required: true\n type: string\n example: __VNF-ID__",""}, +// Test: if ( !path.endsWith("/relationship") && !path.endsWith("}") ) + {"CloudInfrastructurePserversPserverPInterfaces","p-interfaces","CloudInfrastructure","/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces"," - name: hostname\n in: path\n description: Value from executing hostname on the compute node.\n required: true\n type: string\n example: __HOSTNAME__",""}, + // {"","ctag-pool","","","",""}, +// {"","pserver","","","",""}, +// {"","oam-network","","","",""}, +// {"","dvs-switch","","","",""}, +// {"","availability-zone","","","",""} + }; + return Arrays.asList(inputs); + } + + public PutOperationTest(String useOpId, String xmlRootElementName, String tag, String path, String pathParams, String result) { + super(); + this.useOpId = useOpId; + this.xmlRootElementName = xmlRootElementName; + this.tag = tag; + this.path = path; + this.pathParams=pathParams; + this.result = result; + } + @BeforeClass + public static void setUpBeforeClass() throws Exception { + + } + + @Test + public void testToString() { + PutOperation put = new PutOperation(useOpId, xmlRootElementName, tag, path, pathParams, Version.getLatest()); + String modResult = put.toString(); + assertThat(modResult, is(this.result)); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/PutRelationPathSetTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/PutRelationPathSetTest.java new file mode 100644 index 00000000..6b8750fb --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/PutRelationPathSetTest.java @@ -0,0 +1,223 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.aai.introspection.Version; +import org.onap.aai.util.GenerateXsd; + +import java.io.File; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertTrue; + +public class PutRelationPathSetTest { + private DocumentContext jsonContext; + private String json; + private EdgeRuleSet edgeRuleSet; + private Version v = Version.getLatest(); + private File relationsFile = new File(GenerateXsd.getYamlDir() + "/relations/" + v.name()+"/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json"); + private String target = "/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship"; + private String opId = "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship"; + private String path = "/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship"; + PutRelationPathSet prp = null; + + + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + json = "{" + + " \"rules\": [" + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"complex\"," + + " \"label\": \"org.onap.relationships.inventory.LocatedIn\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"this description\"" + + " }," + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"service-capability\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"availability-zone\"," + + " \"to\": \"cloud-region\"," + + " \"label\": \"org.onap.relationships.inventory.BelongsTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"!${direction}\"," + + " \"delete-other-v\": \"!${direction}\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"NONE\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"ctag-pool\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"dvs-switch\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.AppliesTo\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"generic-vnf\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"vf-module\"," + + " \"to\": \"vnfc\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"ONE2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"pserver\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.MemberOf\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2ONE\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"${direction}\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " {" + + " \"from\": \"vce\"," + + " \"to\": \"availability-zone\"," + + " \"label\": \"org.onap.relationships.inventory.Uses\"," + + " \"direction\": \"OUT\"," + + " \"multiplicity\": \"MANY2MANY\"," + + " \"contains-other-v\": \"NONE\"," + + " \"delete-other-v\": \"NONE\"," + + " \"SVC-INFRA\": \"NONE\"," + + " \"prevent-delete\": \"!${direction}\"," + + " \"default\": \"true\"," + + " \"description\":\"\"" + + " }," + + " ]}"; + jsonContext = JsonPath.parse(json); + this.edgeRuleSet = new EdgeRuleSet(jsonContext); + DeleteOperation.deletePaths.put("/cloud-infrastructure/pservers/pserver/{hostname}","pserver"); + DeleteOperation.deletePaths.put("/network/vces/vce/{vnf-id}","vce"); + DeleteOperation.deletePaths.put("/cloud-infrastructure/complexes/complex/{physical-location-id}","complex"); + DeleteOperation.deletePaths.put("/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}","service-capability"); + DeleteOperation.deletePaths.put("/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}","cloud-region"); + DeleteOperation.deletePaths.put("/network/generic-vnfs/generic-vnf/{vnf-id}","generic-vnf"); + DeleteOperation.deletePaths.put("/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}","dvs-switch"); + DeleteOperation.deletePaths.put("/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}","ctag-pool"); + + DeleteOperation.deletePaths.put(path.replace("/relationship-list/relationship", ""),"availability-zone"); + PutRelationPathSet.add(opId, path); + } + + @Test + public void testAdd() { + PutRelationPathSet.add(opId, path); + assertThat(PutRelationPathSet.putRelationPaths.size(), is(1)); + assertThat(PutRelationPathSet.putRelationPaths.get(opId), is(target)); + } + + @Test + public void testPutRelationPathSet() { + + this.prp = new PutRelationPathSet(v); + assertThat(PutRelationPathSet.putRelationPaths.size(), is(1)); + prp.generateRelations(edgeRuleSet); + assertTrue(this.relationsFile.exists()); + this.relationsFile.delete(); + } + + @Test + public void testPutRelationPathSetStringString() { + this.prp = new PutRelationPathSet(opId, path, v); + assertThat(PutRelationPathSet.putRelationPaths.size(), is(1)); + } + + @Test + public void testGenerateRelations() { + PutRelationPathSet prp = new PutRelationPathSet(opId, "availability-zone", v); + prp.generateRelations(edgeRuleSet); + assertThat(PutRelationPathSet.putRelationPaths.size(), is(1)); + assertThat(PutRelationPathSet.putRelationPaths.get(opId), is(target)); + assertTrue(this.relationsFile.exists()); + this.relationsFile.delete(); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDElementTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDElementTest.java new file mode 100644 index 00000000..ccae8578 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDElementTest.java @@ -0,0 +1,564 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.apache.commons.lang.StringUtils; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.aai.exceptions.AAIException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; + +import javax.xml.XMLConstants; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import java.io.IOException; +import java.io.StringReader; +import java.util.*; + +import static org.hamcrest.CoreMatchers.*; +import static org.hamcrest.collection.IsIn.in; +import static org.hamcrest.collection.IsIterableContainingInAnyOrder.containsInAnyOrder; +import static org.hamcrest.core.Every.everyItem; +import static org.junit.Assert.assertThat; + +public class XSDElementTest { + private static final Logger logger = LoggerFactory.getLogger("XSDElementTest.class"); + private static final int maxSizeForXml = 20000; + protected String testXML; + protected Document doc = null; + protected NodeList javaTypeNodes=null; + + public String getTestXML() { + return testXML; + } + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + StringBuilder sb = new StringBuilder(maxSizeForXml); + addNamespace(sb); + addBusiness(sb); + addCustomers(sb); + addCustomer(sb); + addServiceSubscriptions(sb); + addServiceSubscription(sb); + addEndOfXML(sb); + testXML = sb.toString(); + init(); + } + + private void addNamespace(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addBusiness(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addCustomers(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addCustomer(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); +// sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addServiceSubscriptions(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + private void addServiceSubscription(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); +// sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addRelationshipList(StringBuilder sb ) { + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("/n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addRelationship(StringBuilder sb ) { + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append(""); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addRelatedToProperty(StringBuilder sb) { + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + private void addRelationshipData(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + sb.append("\n"); + } + + + private void addEndOfXML(StringBuilder sb){ + sb.append("\n"); + sb.append("\n"); + } + + public void init() throws ParserConfigurationException, SAXException, IOException, AAIException { + DocumentBuilder dBuilder = null; + try { + DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); + dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); + dBuilder = dbFactory.newDocumentBuilder(); + } catch (ParserConfigurationException e) { + throw e; + } + try { + InputSource isInput = new InputSource(new StringReader(testXML)); + doc = dBuilder.parse(isInput); + } catch (SAXException e) { + throw e; + } catch (IOException e) { + throw e; + } + + NodeList bindingsNodes = doc.getElementsByTagName("xml-bindings"); + Element bindingElement; + NodeList javaTypesNodes; + Element javaTypesElement; + + if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { + throw new AAIException("OXM file error: missing in XML"); + } + + bindingElement = (Element) bindingsNodes.item(0); + javaTypesNodes = bindingElement.getElementsByTagName("java-types"); + if ( javaTypesNodes.getLength() < 1 ) { + throw new AAIException("OXM file error: missing in XML"); + } + javaTypesElement = (Element) javaTypesNodes.item(0); + + javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); + if ( javaTypeNodes.getLength() < 1 ) { + throw new AAIException("OXM file error: missing in XML"); + } + logger.debug(testXML); + } + @Test + public void testXSDElement() { + // repeat of testGetIndexedProps() which uses the constructor + ArrayList target = new ArrayList(); + target.add("subscriber-name"); + target.add("global-customer-id"); + target.add("subscriber-type"); + target.add("service-type"); + + Vector indexedProps = new Vector(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + indexedProps.addAll(javaTypeElement.getIndexedProps()); + } + assertThat(new ArrayList<>(indexedProps),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testName() { + ArrayList target = new ArrayList(); + target.add("ServiceSubscriptions"); + target.add("ServiceSubscription"); + target.add("Inventory"); + target.add("Business"); + target.add("Customers"); + target.add("Customer"); + ArrayList names = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + names.add(javaTypeElement.name()); + } + logger.debug(String.join("|", names)); + assertThat(names,both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testGetAddTypes() { + HashMap> map = new HashMap>(); + HashMap> target = new HashMap>(); + target.put("Customer", new ArrayList<>(Arrays.asList("ServiceSubscriptions", "RelationshipList"))); + target.put("Customer", new ArrayList<>(Arrays.asList("ServiceSubscriptions"))); + target.put("Business", new ArrayList<>(Arrays.asList("Customers"))); + target.put("Inventory", new ArrayList<>(Arrays.asList("Business"))); + target.put("Customers", new ArrayList<>(Arrays.asList("Customer"))); + target.put("ServiceSubscription", new ArrayList<>(Arrays.asList("RelationshipList"))); + target.put("ServiceSubscription", new ArrayList<>(Arrays.asList())); + target.put("ServiceSubscriptions", new ArrayList<>(Arrays.asList("ServiceSubscription"))); + + for ( int i = 0; i < javaTypeNodes.getLength(); ++i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + ArrayList addTypes = new ArrayList(); + NodeList xmlElementNodes = javaTypeElement.getElementsByTagName("xml-element"); + String name=javaTypeElement.name(); + for ( int j = 0; j < xmlElementNodes.getLength(); ++j ) { + XSDElement xmlElement = new XSDElement((Element) xmlElementNodes.item(j)); + addTypes.addAll(xmlElement.getAddTypes("v11")); + map.put(name,addTypes); + } + } + for(String key : map.keySet()) { + assertThat("Expected for key:"+key, map.get(key),equalTo(target.get(key))); + } + } +/* + @Test + public void testGetRequiredElements() { + HashMap> map = new HashMap>(); + ArrayList target = new ArrayList(); + target.add("global-customer-id\n"); + target.add("subscriber-name\n"); + target.add("subscriber-type"); + for ( int i = 0; i < javaTypeNodes.getLength(); ++i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + ArrayList requiredItems = new ArrayList(); + String name=javaTypeElement.name(); + requiredItems.addAll(javaTypeElement.getRequiredElements("v11")); + map.put(name,requiredItems); + } + for(String key : map.keySet()) { + assertThat(map.get(key),equalTo(target)); + } + } +*/ + @Test + public void testGetPathDescriptionProperty() { + ArrayList target = new ArrayList(); + target.add("Namespace for business related constructs"); + target.add("Collection of customer identifiers to provide linkage back to BSS information."); + target.add("customer identifiers to provide linkage back to BSS information."); + target.add("Collection of objects that group service instances."); + target.add("Object that group service instances."); + List descs = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getPathDescriptionProperty() != null) + descs.add(javaTypeElement.getPathDescriptionProperty()); + } + logger.debug(String.join("|", descs)); + assertThat(new ArrayList<>(descs),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testGetIndexedProps() { + ArrayList target = new ArrayList(); + target.add("subscriber-name"); + target.add("global-customer-id"); + target.add("subscriber-type"); + target.add("service-type"); + + Vector indexedProps = new Vector(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + indexedProps.addAll(javaTypeElement.getIndexedProps()); + } + assertThat(new ArrayList<>(indexedProps),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testGetContainerProperty() { + ArrayList target = new ArrayList(); + target.add("service-subscriptions"); + target.add("customers"); + List containers = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getContainerProperty() != null) + containers.add(javaTypeElement.getContainerProperty()); + } + logger.debug(String.join("|", containers)); + assertThat(new ArrayList<>(containers),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testGetQueryParamYAML() { + ArrayList target = new ArrayList(); + target.add(" - name: global-customer-id\n in: query\n description:\n required: false\n type: string\n"); + target.add(" - name: subscriber-name\n in: query\n description:\n required: false\n type: string\n"); + target.add(" - name: subscriber-type\n in: query\n description:\n required: false\n type: string\n"); + Vector indexedProps = new Vector(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getContainerProperty() != null) { + indexedProps.addAll(javaTypeElement.getIndexedProps()); + String container = javaTypeElement.getContainerProperty(); + Vector containerProps = new Vector(); + NodeList xmlElementNodes = javaTypeElement.getElementsByTagName("xml-element"); + for ( int j = 0; j < xmlElementNodes.getLength(); ++j ) { + XSDElement xmlElement = new XSDElement((Element) xmlElementNodes.item(j)); + if(indexedProps.contains(xmlElement.name())) + containerProps.add(xmlElement.getQueryParamYAML()); + } + GetOperation.addContainerProps(container, containerProps); + } + } +/* + List queryParams = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getQueryParamYAML() != null) + queryParams.add(javaTypeElement.getQueryParamYAML()); + } +*/ + assertThat(GetOperation.containers.get("customers"),equalTo( target)); + } + + @Test + public void testGetPathParamYAML() { + ArrayList target = new ArrayList(); + target.add(" - name: Inventory\n in: path\n description: Inventory\n required: true\n example: __INVENTORY__\n"); + target.add(" - name: Business\n in: path\n description: Business\n required: true\n example: __BUSINESS__\n"); + target.add(" - name: Customers\n in: path\n description: Customers\n required: true\n example: __CUSTOMERS__\n"); + target.add(" - name: Customer\n in: path\n description: Customer\n required: true\n example: __CUSTOMER__\n"); + target.add(" - name: ServiceSubscriptions\n in: path\n description: ServiceSubscriptions\n required: true\n example: __SERVICESUBSCRIPTIONS__\n"); + target.add(" - name: ServiceSubscription\n in: path\n description: ServiceSubscription\n required: true\n example: __SERVICESUBSCRIPTION__\n"); + List pathParams = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getPathParamYAML(javaTypeElement.name()) != null) + pathParams.add(javaTypeElement.getPathParamYAML(javaTypeElement.name())); + } + logger.debug(String.join("|", pathParams)); + assertThat(new ArrayList<>(pathParams),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testGetHTMLAnnotation() { + ArrayList target = new ArrayList(); + target.add(" \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Namespace for business related constructs\")\r\n \r\n \r\n"); + target.add(" \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Collection of customer identifiers to provide linkage back to BSS information.\")\r\n \r\n \r\n"); + target.add(" \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"customer identifiers to provide linkage back to BSS information.\",nameProps=\"subscriber-name\",indexedProps=\"subscriber-name,global-customer-id,subscriber-type\",searchable=\"global-customer-id,subscriber-name\",uniqueProps=\"global-customer-id\",container=\"customers\",namespace=\"business\")\r\n \r\n \r\n"); + target.add(" \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Collection of objects that group service instances.\")\r\n \r\n \r\n"); + target.add(" \r\n \r\n @org.onap.aai.annotations.Metadata(description=\"Object that group service instances.\",indexedProps=\"service-type\",dependentOn=\"customer\",container=\"service-subscriptions\",crossEntityReference=\"service-instance,service-type\")\r\n \r\n \r\n"); + List annotes = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(StringUtils.isNotEmpty(javaTypeElement.getHTMLAnnotation(javaTypeElement.name(),""))) + annotes.add(javaTypeElement.getHTMLAnnotation(javaTypeElement.name(), " ")); + } + logger.debug("result:"); + logger.debug(String.join("|", annotes)); + logger.debug("Expected:"); + logger.debug(String.join("|", target)); + assertThat(new ArrayList<>(annotes),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + + } + + @Test + public void testGetTypePropertyYAML() { + ArrayList target = new ArrayList(); + target.add(" Inventory:\n type: "); + target.add(" Business:\n type: description: Namespace for business related constructs\n"); + target.add(" Customers:\n type: description: Collection of customer identifiers to provide linkage back to BSS information.\n"); + target.add(" Customer:\n type: description: customer identifiers to provide linkage back to BSS information.\n"); + target.add(" ServiceSubscriptions:\n type: description: Collection of objects that group service instances.\n"); + target.add(" ServiceSubscription:\n type: description: Object that group service instances.\n"); + List types = new ArrayList(); + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + if(javaTypeElement.getTypePropertyYAML() != null) + types.add(javaTypeElement.getTypePropertyYAML()); + } + assertThat(new ArrayList<>(types),both(everyItem(is(in(target.toArray())))).and(containsInAnyOrder(target.toArray()))); + } + + @Test + public void testIsStandardType() { + HashMap> map = new HashMap>(); + HashMap> target = new HashMap>(); + target.put("Customer", new ArrayList<>(Arrays.asList("global-customer-id","subscriber-name", "subscriber-type","resource-version"))); + target.put("Business", new ArrayList<>()); + target.put("Inventory", new ArrayList<>()); + target.put("Customers", new ArrayList<>()); + target.put("ServiceSubscriptions", new ArrayList<>()); + target.put("ServiceSubscription", new ArrayList<>(Arrays.asList("service-type", "temp-ub-sub-account-id", "resource-version"))); + + for ( int i = 0; i < javaTypeNodes.getLength(); ++i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + ArrayList addTypes = new ArrayList(); + NodeList xmlElementNodes = javaTypeElement.getElementsByTagName("xml-element"); + String name=javaTypeElement.name(); + for ( int j = 0; j < xmlElementNodes.getLength(); ++j ) { + XSDElement xmlElement = new XSDElement((Element) xmlElementNodes.item(j)); + if(xmlElement.isStandardType()) + addTypes.add(xmlElement.name()); + } + map.put(name,addTypes); + } + for(String key : map.keySet()) { + assertThat(map.get(key),equalTo(target.get(key))); + } + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDJavaTypeTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDJavaTypeTest.java new file mode 100644 index 00000000..7a2f9be9 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/XSDJavaTypeTest.java @@ -0,0 +1,101 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.Before; +import org.junit.Test; +import org.w3c.dom.Element; + +import java.util.HashMap; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.junit.Assert.assertThat; + +public class XSDJavaTypeTest extends XSDElementTest { + + @Before + public void setUp() throws Exception { + super.setUp(); + } + + @Test + public void testXSDJavaTypeElement() { + HashMap map = new HashMap(); + HashMap target = new HashMap(); + target.put("Customer", "global-customer-id"); + target.put("Business", "customers"); + target.put("Inventory", "business"); + target.put("Customers","customer"); + target.put("ServiceSubscriptions", "service-subscription"); + target.put("ServiceSubscription", "service-type"); + + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + XSDJavaType javaType = new XSDJavaType(javaTypeElement); + map.put(javaType.name(),javaType.getItemName()); + } + for(String key : map.keySet()) { + assertThat("For key: "+key,map.get(key),equalTo(target.get(key))); + } + } + + @Test + public void testGetItemName() { + HashMap map = new HashMap(); + HashMap target = new HashMap(); + target.put("Customer", "global-customer-id"); + target.put("Business", "customers"); + target.put("Inventory", "business"); + target.put("Customers","customer"); + target.put("ServiceSubscriptions", "service-subscription"); + target.put("ServiceSubscription", "service-type"); + + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + XSDJavaType javaType = new XSDJavaType(javaTypeElement); + map.put(javaType.name(),javaType.getItemName()); + } + for(String key : map.keySet()) { + assertThat("For key: "+key,map.get(key),equalTo(target.get(key))); + } + } + + @Test + public void testGetArrayType() { + HashMap map = new HashMap(); + HashMap target = new HashMap(); + target.put("Customer", null); + target.put("Business", null); + target.put("Inventory", null); + target.put("Customers","customer"); + target.put("ServiceSubscriptions", "service-subscription"); + target.put("ServiceSubscription", null); + + for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { + XSDElement javaTypeElement = new XSDElement((Element) javaTypeNodes.item(i)); + XSDJavaType javaType = new XSDJavaType(javaTypeElement); + map.put(javaType.name(),javaType.getArrayType()); + } + for(String key : map.keySet()) { + assertThat(map.get(key),equalTo(target.get(key))); + } + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/genxsd/YAMLfromOXMTest.java b/aai-core/src/test/java/org/onap/aai/util/genxsd/YAMLfromOXMTest.java new file mode 100644 index 00000000..665c770b --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/genxsd/YAMLfromOXMTest.java @@ -0,0 +1,826 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.util.genxsd; + +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.onap.aai.introspection.Version; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Element; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertThat; + +public class YAMLfromOXMTest { + private static final Logger logger = LoggerFactory.getLogger("YAMLfromOXMTest.class"); + private String testXML; + + @BeforeClass + public static void setUpBeforeClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + XSDElementTest x = new XSDElementTest(); + x.setUp(); + testXML = x.testXML; + logger.debug(testXML); + } + + @Test + public void testGetDocumentHeader() { + Version v = Version.v11; + String apiVersion = v.toString(); + String header = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + swagger.process(); + header = swagger.getDocumentHeader(); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("Header:\n"+header,header, is(YAMLheader())); + } + + @Test + public void testProcess() { + Version v = Version.v11; + String apiVersion = v.toString(); + String fileContent = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + fileContent = swagger.process(); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("FileContent-TestProcess:\n"+fileContent,fileContent, is(YAMLresult())); + } + + @Test + public void testYAMLfromOXMFileVersionFile() throws IOException { + String outfileName = "testXML.xml"; + File XMLfile = new File(outfileName); + XMLfile.createNewFile(); + BufferedWriter bw = null; + Charset charset = Charset.forName("UTF-8"); + Path path = Paths.get(outfileName); + bw = Files.newBufferedWriter(path, charset); + bw.write(testXML); + bw.close(); + Version v = Version.v11; + String apiVersion = v.toString(); + String fileContent = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(XMLfile, v, edgeRuleFile); + fileContent = swagger.process(); + } catch(Exception e) { + e.printStackTrace(); + } + XMLfile.delete(); + assertThat("FileContent-OXMFileVersionFile:\n"+fileContent,fileContent, is(YAMLresult())); + } + + @Test + public void testYAMLfromOXMStringVersionFile() { + Version v = Version.v11; + String apiVersion = v.toString(); + String fileContent = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + fileContent = swagger.process(); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("FileContent-OXMStringVersionFile:\n"+fileContent,fileContent, is(YAMLresult())); + } + + @Test + public void testAppendDefinitions() { + Version v = Version.v11; + String apiVersion = v.toString(); + String definitions = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + swagger.process(); + definitions = swagger.appendDefinitions(); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("Definitions:\n"+definitions,definitions, is(YAMLdefs()+YAMLpatchDefs()+YAMLgetDefs())); + } + + @Test + public void testGetXMLRootElementName() { + String target = "RootElement=customer"; + Version v = Version.v11; + String apiVersion = v.toString(); + Element customer = null; + String root = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + swagger.process(); + customer = swagger.getJavaTypeElementSwagger("Customer"); + root = swagger.getXMLRootElementName(customer); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("RootElement="+root, is(target)); + } + + @Test + public void testGetXmlRootElementName() { + String target = "RootElement=customer"; + Version v = Version.v11; + String apiVersion = v.toString(); + String root = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + swagger.process(); + root = swagger.getXmlRootElementName("Customer"); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("RootElement="+root, is(target)); + } + + @Test + public void testGetJavaTypeElementSwagger() { + String target = "Element=java-type/Customer"; + Version v = Version.v11; + String apiVersion = v.toString(); + Element customer = null; + File edgeRuleFile = new File("../aai-core" + "/src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + try { + YAMLfromOXM swagger = new YAMLfromOXM(testXML, v, edgeRuleFile); + swagger.process(); + customer = swagger.getJavaTypeElementSwagger("Customer"); + } catch(Exception e) { + e.printStackTrace(); + } + assertThat("Element="+customer.getNodeName()+"/"+customer.getAttribute("name"), is(target)); + } + + public String YAMLresult() { + StringBuilder sb = new StringBuilder(32368); + sb.append(YAMLheader()); + sb.append(YAMLops()); + sb.append(YAMLdefs()); + sb.append(YAMLpatchDefs()); + sb.append(YAMLgetDefs()); + return sb.toString(); + } + public String YAMLheader() { + StringBuilder sb = new StringBuilder(1500); + sb.append("swagger: \"2.0\"\n"); + sb.append("info:\n"); + sb.append(" description: |\n"); + sb.append("\n"); + sb.append(" [Differences versus the previous schema version](apidocs/aai_swagger_v11.diff)\n"); + sb.append("\n"); + sb.append(" Copyright © 2017 AT&T Intellectual Property. All rights reserved.\n"); + sb.append("\n"); + sb.append(" Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.\n"); + sb.append("\n"); + sb.append(" You may obtain a copy of the License at\n"); + sb.append("\n"); + sb.append(" (https://creativecommons.org/licenses/by/4.0/)\n"); + sb.append("\n"); + sb.append(" Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n"); + sb.append("\n"); + sb.append(" ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.\n"); + sb.append("\n"); + sb.append(" This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.\n"); + sb.append(" version: \"v11\"\n"); + sb.append(" title: Active and Available Inventory REST API\n"); + sb.append(" license:\n"); + sb.append(" name: Apache 2.0\n"); + sb.append(" url: http://www.apache.org/licenses/LICENSE-2.0.html\n"); + sb.append(" contact:\n"); + sb.append(" name:\n"); + sb.append(" url:\n"); + sb.append(" email:\n"); + sb.append("host:\n"); + sb.append("basePath: /aai/v11\n"); + sb.append("schemes:\n"); + sb.append(" - https\n"); + sb.append("paths:\n"); + return sb.toString(); + } + + public String YAMLops() { + StringBuilder sb = new StringBuilder(16384); + sb.append(" /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:\n"); + sb.append(" get:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: returns service-subscription\n"); + sb.append(" description: returns service-subscription\n"); + sb.append(" operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"200\":\n"); + sb.append(" description: successful operation\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/getDefinitions/service-subscription\"\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: service-type\n"); + sb.append(" in: path\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __SERVICE-TYPE__\n"); + sb.append(" put:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: create or update an existing service-subscription\n"); + sb.append(" description: |\n"); + sb.append(" Create or update an existing service-subscription.\n"); + sb.append(" #\n"); + sb.append(" Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n"); + sb.append(" operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: service-type\n"); + sb.append(" in: path\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __SERVICE-TYPE__\n"); + sb.append(" - name: body\n"); + sb.append(" in: body\n"); + sb.append(" description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)\n"); + sb.append(" required: true\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/definitions/service-subscription\"\n"); + sb.append(" patch:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: update an existing service-subscription\n"); + sb.append(" description: |\n"); + sb.append(" Update an existing service-subscription\n"); + sb.append(" #\n"); + sb.append(" Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n"); + sb.append(" The PUT operation will entirely replace an existing object.\n"); + sb.append(" The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n"); + sb.append(" #\n"); + sb.append(" Other differences between PUT and PATCH are:\n"); + sb.append(" #\n"); + sb.append(" - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n"); + sb.append(" - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n"); + sb.append(" - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n"); + sb.append(" operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: service-type\n"); + sb.append(" in: path\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __SERVICE-TYPE__\n"); + sb.append(" - name: body\n"); + sb.append(" in: body\n"); + sb.append(" description: service-subscription object that needs to be updated.\n"); + sb.append(" required: true\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/patchDefinitions/service-subscription\"\n"); + sb.append(" delete:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: delete an existing service-subscription\n"); + sb.append(" description: delete an existing service-subscription\n"); + sb.append(" operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: service-type\n"); + sb.append(" in: path\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __SERVICE-TYPE__\n"); + sb.append(" - name: resource-version\n"); + sb.append(" in: query\n"); + sb.append(" description: resource-version for concurrency\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" /business/customers/customer/{global-customer-id}/service-subscriptions:\n"); + sb.append(" get:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: returns service-subscriptions\n"); + sb.append(" description: returns service-subscriptions\n"); + sb.append(" operationId: getBusinessCustomersCustomerServiceSubscriptions\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"200\":\n"); + sb.append(" description: successful operation\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/getDefinitions/service-subscriptions\"\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: service-type\n"); + sb.append(" in: query\n"); + sb.append(" description:\n"); + sb.append(" required: false\n"); + sb.append(" type: string\n"); + sb.append(" /business/customers/customer/{global-customer-id}:\n"); + sb.append(" get:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: returns customer\n"); + sb.append(" description: returns customer\n"); + sb.append(" operationId: getBusinessCustomersCustomer\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"200\":\n"); + sb.append(" description: successful operation\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/getDefinitions/customer\"\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" put:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: create or update an existing customer\n"); + sb.append(" description: |\n"); + sb.append(" Create or update an existing customer.\n"); + sb.append(" #\n"); + sb.append(" Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below\n"); + sb.append(" operationId: createOrUpdateBusinessCustomersCustomer\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: body\n"); + sb.append(" in: body\n"); + sb.append(" description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)\n"); + sb.append(" required: true\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/definitions/customer\"\n"); + sb.append(" patch:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: update an existing customer\n"); + sb.append(" description: |\n"); + sb.append(" Update an existing customer\n"); + sb.append(" #\n"); + sb.append(" Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\n"); + sb.append(" The PUT operation will entirely replace an existing object.\n"); + sb.append(" The PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n"); + sb.append(" #\n"); + sb.append(" Other differences between PUT and PATCH are:\n"); + sb.append(" #\n"); + sb.append(" - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.\n"); + sb.append(" - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.\n"); + sb.append(" - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.\n"); + sb.append(" operationId: UpdateBusinessCustomersCustomer\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: body\n"); + sb.append(" in: body\n"); + sb.append(" description: customer object that needs to be updated.\n"); + sb.append(" required: true\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/patchDefinitions/customer\"\n"); + sb.append(" delete:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: delete an existing customer\n"); + sb.append(" description: delete an existing customer\n"); + sb.append(" operationId: deleteBusinessCustomersCustomer\n"); + sb.append(" consumes:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: path\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" example: __GLOBAL-CUSTOMER-ID__\n"); + sb.append(" - name: resource-version\n"); + sb.append(" in: query\n"); + sb.append(" description: resource-version for concurrency\n"); + sb.append(" required: true\n"); + sb.append(" type: string\n"); + sb.append(" /business/customers:\n"); + sb.append(" get:\n"); + sb.append(" tags:\n"); + sb.append(" - Business\n"); + sb.append(" summary: returns customers\n"); + sb.append(" description: returns customers\n"); + sb.append(" operationId: getBusinessCustomers\n"); + sb.append(" produces:\n"); + sb.append(" - application/json\n"); + sb.append(" - application/xml\n"); + sb.append(" responses:\n"); + sb.append(" \"200\":\n"); + sb.append(" description: successful operation\n"); + sb.append(" schema:\n"); + sb.append(" $ref: \"#/getDefinitions/customers\"\n"); + sb.append(" \"default\":\n"); + sb.append(" null parameters:\n"); + sb.append(" - name: global-customer-id\n"); + sb.append(" in: query\n"); + sb.append(" description:\n"); + sb.append(" required: false\n"); + sb.append(" type: string\n"); + sb.append(" - name: subscriber-name\n"); + sb.append(" in: query\n"); + sb.append(" description:\n"); + sb.append(" required: false\n"); + sb.append(" type: string\n"); + sb.append(" - name: subscriber-type\n"); + sb.append(" in: query\n"); + sb.append(" description:\n"); + sb.append(" required: false\n"); + sb.append(" type: string\n"); + return sb.toString(); + } + public String YAMLdefs() { + StringBuilder sb = new StringBuilder(8092); + sb.append("definitions:\n"); + sb.append(" business:\n"); + sb.append(" description: |\n"); + sb.append(" Namespace for business related constructs\n"); + sb.append(" properties:\n"); + sb.append(" customers:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/definitions/customer\"\n"); + sb.append(" customer:\n"); + sb.append(" description: |\n"); + sb.append(" customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - global-customer-id\n"); + sb.append(" - subscriber-name\n"); + sb.append(" - subscriber-type\n"); + sb.append(" properties:\n"); + sb.append(" global-customer-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" subscriber-name:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber name, an alternate way to retrieve a customer.\n"); + sb.append(" subscriber-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber type, a way to provide VID with only the INFRA customers.\n"); + sb.append(" resource-version:\n"); + sb.append(" type: string\n"); + sb.append(" description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.\n"); + sb.append(" service-subscriptions:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/definitions/service-subscription\"\n"); + sb.append(" customers:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" properties:\n"); + sb.append(" customer:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/definitions/customer\"\n"); + sb.append(" inventory:\n"); + sb.append(" properties:\n"); + sb.append(" business:\n"); + sb.append(" type: object\n"); + sb.append(" $ref: \"#/definitions/business\"\n"); + sb.append(" nodes:\n"); + sb.append(" properties:\n"); + sb.append(" inventory-item-data:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/definitions/inventory-item-data\"\n"); + sb.append(" service-subscription:\n"); + sb.append(" description: |\n"); + sb.append(" Object that group service instances.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)\n"); + sb.append(" - TO tenant( service-subscription Uses tenant, MANY2MANY)\n"); + sb.append(" - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also\n"); + sb.append(" -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - service-type\n"); + sb.append(" properties:\n"); + sb.append(" service-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" temp-ub-sub-account-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: This property will be deleted from A&AI in the near future. Only stop gap solution.\n"); + sb.append(" resource-version:\n"); + sb.append(" type: string\n"); + sb.append(" description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.\n"); + sb.append(" service-subscriptions:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of objects that group service instances.\n"); + sb.append(" properties:\n"); + sb.append(" service-subscription:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/definitions/service-subscription\"\n"); + return sb.toString(); + } + public String YAMLpatchDefs() { + StringBuilder sb = new StringBuilder(8092); + sb.append("patchDefinitions:\n"); + sb.append(" business:\n"); + sb.append(" description: |\n"); + sb.append(" Namespace for business related constructs\n"); + sb.append(" properties:\n"); + sb.append(" customers:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/patchDefinitions/customer\"\n"); + sb.append(" customer:\n"); + sb.append(" description: |\n"); + sb.append(" customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - global-customer-id\n"); + sb.append(" - subscriber-name\n"); + sb.append(" - subscriber-type\n"); + sb.append(" properties:\n"); + sb.append(" global-customer-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" subscriber-name:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber name, an alternate way to retrieve a customer.\n"); + sb.append(" subscriber-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber type, a way to provide VID with only the INFRA customers.\n"); + sb.append(" customers:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" properties:\n"); + sb.append(" customer:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/patchDefinitions/customer\"\n"); + sb.append(" inventory:\n"); + sb.append(" properties:\n"); + sb.append(" business:\n"); + sb.append(" type: object\n"); + sb.append(" $ref: \"#/patchDefinitions/business\"\n"); + sb.append(" nodes:\n"); + sb.append(" properties:\n"); + sb.append(" inventory-item-data:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/patchDefinitions/inventory-item-data\"\n"); + sb.append(" service-subscription:\n"); + sb.append(" description: |\n"); + sb.append(" Object that group service instances.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)\n"); + sb.append(" - TO tenant( service-subscription Uses tenant, MANY2MANY)\n"); + sb.append(" - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also\n"); + sb.append(" -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - service-type\n"); + sb.append(" properties:\n"); + sb.append(" service-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" temp-ub-sub-account-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: This property will be deleted from A&AI in the near future. Only stop gap solution.\n"); + sb.append(" service-subscriptions:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of objects that group service instances.\n"); + sb.append(" properties:\n"); + sb.append(" service-subscription:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/patchDefinitions/service-subscription\"\n"); + return sb.toString(); + } + public String YAMLgetDefs() { + StringBuilder sb = new StringBuilder(8092); + sb.append("getDefinitions:\n"); + sb.append(" business:\n"); + sb.append(" description: |\n"); + sb.append(" Namespace for business related constructs\n"); + sb.append(" properties:\n"); + sb.append(" customers:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/getDefinitions/customer\"\n"); + sb.append(" customer:\n"); + sb.append(" description: |\n"); + sb.append(" customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - global-customer-id\n"); + sb.append(" - subscriber-name\n"); + sb.append(" - subscriber-type\n"); + sb.append(" properties:\n"); + sb.append(" global-customer-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: Global customer id used across ECOMP to uniquely identify customer.\n"); + sb.append(" subscriber-name:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber name, an alternate way to retrieve a customer.\n"); + sb.append(" subscriber-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Subscriber type, a way to provide VID with only the INFRA customers.\n"); + sb.append(" resource-version:\n"); + sb.append(" type: string\n"); + sb.append(" description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.\n"); + sb.append(" service-subscriptions:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/getDefinitions/service-subscription\"\n"); + sb.append(" customers:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of customer identifiers to provide linkage back to BSS information.\n"); + sb.append(" properties:\n"); + sb.append(" customer:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/getDefinitions/customer\"\n"); + sb.append(" inventory:\n"); + sb.append(" properties:\n"); + sb.append(" business:\n"); + sb.append(" type: object\n"); + sb.append(" $ref: \"#/getDefinitions/business\"\n"); + sb.append(" nodes:\n"); + sb.append(" properties:\n"); + sb.append(" inventory-item-data:\n"); + sb.append(" type: array\n"); + sb.append(" items:\n"); + sb.append(" $ref: \"#/getDefinitions/inventory-item-data\"\n"); + sb.append(" service-subscription:\n"); + sb.append(" description: |\n"); + sb.append(" Object that group service instances.\n"); + sb.append(" ###### Related Nodes\n"); + sb.append(" - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)\n"); + sb.append(" - TO tenant( service-subscription Uses tenant, MANY2MANY)\n"); + sb.append(" - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)\n"); + sb.append("\n"); + sb.append(" -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also\n"); + sb.append(" -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also\n"); + sb.append(" required:\n"); + sb.append(" - service-type\n"); + sb.append(" properties:\n"); + sb.append(" service-type:\n"); + sb.append(" type: string\n"); + sb.append(" description: Value defined by orchestration to identify this service across ECOMP.\n"); + sb.append(" temp-ub-sub-account-id:\n"); + sb.append(" type: string\n"); + sb.append(" description: This property will be deleted from A&AI in the near future. Only stop gap solution.\n"); + sb.append(" resource-version:\n"); + sb.append(" type: string\n"); + sb.append(" description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.\n"); + sb.append(" service-subscriptions:\n"); + sb.append(" description: |\n"); + sb.append(" Collection of objects that group service instances.\n"); + sb.append(" properties:\n"); + sb.append(" service-subscription:\n"); + sb.append(" type: array\n"); + sb.append(" items: \n"); + sb.append(" $ref: \"#/getDefinitions/service-subscription\"\n"); + return sb.toString(); + } +} diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html index 5247c281..285b219c 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html @@ -5104,70 +5104,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns connectors

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns connector
-

GET /business/connectors/connector/{resource-instance-id}

- Tags: - Business -
-
-
-

returns connector

-
@@ -5186,15 +5122,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen resource-instance-id - + @@ -5202,7 +5136,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Unique id of resource instance.

pathquery string -
-

the ASDC model id for this resource or service model.

query @@ -5217,7 +5150,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -5232,7 +5164,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -5247,7 +5178,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -5283,7 +5213,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -5296,7 +5226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5312,35 +5242,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing connector
-

PUT /business/connectors/connector/{resource-instance-id}

+
returns connector
+

GET /business/connectors/connector/{resource-instance-id}

Tags: Business
-

create or update an existing connector

+

returns connector

-
- -

application/json application/xml -

-
-
-

connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)

-

-
-
-
- -
-
-
@@ -5378,6 +5291,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -5385,7 +5321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5401,16 +5337,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing connector
-

PATCH /business/connectors/connector/{resource-instance-id}

+
create or update an existing connector
+

PUT /business/connectors/connector/{resource-instance-id}

Tags: Business
-

update an existing connector

+

create or update an existing connector

@@ -5419,13 +5355,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

connector object that needs to be created or updated.

+

connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)

@@ -5474,7 +5410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5490,22 +5426,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing connector
-

DELETE /business/connectors/connector/{resource-instance-id}

+
update an existing connector
+

PATCH /business/connectors/connector/{resource-instance-id}

Tags: Business
-

delete an existing connector

+

update an existing connector

application/json application/xml

+
+
+

connector object that needs to be updated.

+

+
+
+
+ +
+
@@ -5535,22 +5483,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -5567,7 +5499,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5582,19 +5514,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadata
-

GET /business/connectors/connector/{resource-instance-id}/metadata

+
delete an existing connector
+

DELETE /business/connectors/connector/{resource-instance-id}

Tags: Business
-

returns metadata

+

delete an existing connector

+
+ +

application/json application/xml +

+
@@ -5625,55 +5562,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -5692,29 +5585,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
default @@ -5722,7 +5592,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5737,17 +5607,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadatum
-

GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+
returns metadata
+

GET /business/connectors/connector/{resource-instance-id}/metadata

Tags: Business
-

returns metadatum

+

returns metadata

@@ -5783,37 +5653,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen metaname
- - - - - - - - - - - - - - + +
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version + resource-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

resource-version for concurrency

query @@ -5681,6 +5573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- path - string - - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

query @@ -5823,34 +5662,114 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + - + - + @@ -5892,7 +5811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -5996,7 +5915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6030,7 +5949,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

@@ -6100,7 +6019,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6208,7 +6127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6297,7 +6216,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6374,7 +6293,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6401,70 +6320,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns customers

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns customer
-

GET /business/customers/customer/{global-customer-id}

- Tags: - Business -
-
-
-

returns customer

-
- widget-model-id + resource-instance-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique id of resource instance.

querypath string +
- widget-model-version + metaname -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

querypath string +
@@ -6483,15 +6338,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen global-customer-id - + @@ -6499,7 +6352,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-name - - - - - - - - - - - - - - - - - - - - -
-

Global customer id used across ECOMP to uniquely identify customer.

pathquery string -
-

Subscriber name, an alternate way to retrieve a customer.

query @@ -6514,7 +6366,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-type -

Subscriber type, a way to provide VID with only the INFRA customers.

query @@ -6550,7 +6401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -6563,7 +6414,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6579,35 +6430,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing customer
-

PUT /business/customers/customer/{global-customer-id}

+
returns customer
+

GET /business/customers/customer/{global-customer-id}

Tags: Business
-

create or update an existing customer

+

returns customer

-
- -

application/json application/xml -

-
-
-

customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)

-

-
-
-
-
- /customer -
-
-
-
@@ -6645,6 +6479,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /customer +
+
+
+ +
default @@ -6652,7 +6509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6668,16 +6525,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing customer
-

PATCH /business/customers/customer/{global-customer-id}

+
create or update an existing customer
+

PUT /business/customers/customer/{global-customer-id}

Tags: Business
-

update an existing customer

+

create or update an existing customer

@@ -6686,13 +6543,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

customer object that needs to be created or updated.

+

customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)

@@ -6741,7 +6598,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6757,16 +6614,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing customer
-

DELETE /business/customers/customer/{global-customer-id}

+
update an existing customer
+

PATCH /business/customers/customer/{global-customer-id}

Tags: Business
-

delete an existing customer

+

update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

customer object that needs to be updated.

+

+
+
+
+
+ /customer +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing customer
+

DELETE /business/customers/customer/{global-customer-id}

+ Tags: + Business +
+
+
+

delete an existing customer

@@ -6834,7 +6780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6923,7 +6869,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7000,7 +6946,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7058,25 +7004,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type + service-type -

Subscriber type, a way to provide VID with only the INFRA customers.

query @@ -7125,7 +7055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7197,36 +7127,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
@@ -7266,7 +7166,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7371,7 +7271,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7405,7 +7305,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-subscription object that needs to be created or updated.

+

service-subscription object that needs to be updated.

@@ -7476,7 +7376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7585,7 +7485,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7690,7 +7590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7783,7 +7683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7810,147 +7710,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns service-instances

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- global-customer-id - -

Global customer id used across ECOMP to uniquely identify customer.

-
path - string - - - -
- service-type - -

Value defined by orchestration to identify this service across ECOMP.

-
path - string - - - -
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns service-instance
-

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

- Tags: - Business -
-
-
-

returns service-instance

-
@@ -8001,23 +7760,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-instance-id - + + +
-

Uniquely identifies this instance of a service

pathquery string -
- subscriber-name + service-instance-name -

Subscriber name, an alternate way to retrieve a customer.

query @@ -8029,10 +7785,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-type + model-invariant-id -

Subscriber type, a way to provide VID with only the INFRA customers.

query @@ -8044,10 +7799,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-instance-name + model-version-id -

This field will store a name assigned to the service-instance.

query @@ -8059,10 +7813,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + widget-model-id -

the ASDC model id for this resource or service model.

query @@ -8074,10 +7827,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + widget-model-version -

the ASDC model version for this resource or service model.

query @@ -8089,10 +7841,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + service-instance-location-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -8104,10 +7855,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + orchestration-status -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -8117,34 +7867,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-instance
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

+ Tags: + Business +
+
+
+

returns service-instance

+ +
+
+ + + + + + + + + + + + + + + + + + - + - + @@ -8186,7 +8033,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8307,7 +8154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8341,7 +8188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-instance object that needs to be created or updated.

+

service-instance object that needs to be updated.

@@ -8428,7 +8275,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8553,7 +8400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8643,10 +8490,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
- service-instance-location-id + service-type -

An identifier that customers assign to the location where this service is being used.

+

Value defined by orchestration to identify this service across ECOMP.

querypath string +
- orchestration-status + service-instance-id -

Orchestration status of this service.

+

Uniquely identifies this instance of a service

querypath string +
- subscriber-name + id -

Subscriber name, an alternate way to retrieve a customer.

query @@ -8658,10 +8504,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-type + model-invariant-id -

Subscriber type, a way to provide VID with only the INFRA customers.

query @@ -8673,10 +8518,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-instance-name + model-version-id -

This field will store a name assigned to the service-instance.

query @@ -8688,10 +8532,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + type -

the ASDC model id for this resource or service model.

query @@ -8703,10 +8546,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + role -

the ASDC model version for this resource or service model.

query @@ -8716,64 +8558,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns allotted-resource
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+ Tags: + Business +
+
+
+

returns allotted-resource

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -8802,7 +8727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -8815,7 +8740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8831,18 +8756,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns allotted-resource
-

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+
create or update an existing allotted-resource
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

Tags: Business
-

returns allotted-resource

+

create or update an existing allotted-resource

+
+ +

application/json application/xml +

+
+
+

allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

+
+
+
+
+
- widget-model-id + global-customer-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Global customer id used across ECOMP to uniquely identify customer.

querypath string +
- widget-model-version + service-type -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Value defined by orchestration to identify this service across ECOMP.

querypath string +
- service-instance-location-id + service-instance-id -

An identifier that customers assign to the location where this service is being used.

+

Uniquely identifies this instance of a service

querypath string +
- orchestration-status + id -

Orchestration status of this service.

+

Allotted Resource id UUID assigned to this instance.

querypath string +
@@ -8919,201 +8861,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role - -

role in the network that this resource will be providing.

-
query - string - - -
@@ -9123,29 +8870,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -9153,7 +8877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9169,16 +8893,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing allotted-resource
-

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+
update an existing allotted-resource
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

Tags: Business
-

create or update an existing allotted-resource

+

update an existing allotted-resource

@@ -9187,13 +8911,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

allotted-resource object that needs to be updated.

@@ -9290,7 +9014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9306,34 +9030,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing allotted-resource
-

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+
delete an existing allotted-resource
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

Tags: Business
-

update an existing allotted-resource

+

delete an existing allotted-resource

application/json application/xml

-
-
-

allotted-resource object that needs to be created or updated.

-

-
-
-
-
@@ -9411,6 +9123,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -9427,7 +9155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9442,23 +9170,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing allotted-resource
-

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

+
see node definition for valid relationships
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

Tags: Business
-

delete an existing allotted-resource

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

+
+
+
+ +
+
@@ -9536,22 +9276,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -9568,7 +9292,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9584,34 +9308,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
see node definition for valid relationships
-

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

Tags: Business
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

-

-
-
-
- -
-
@@ -9705,7 +9417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9720,24 +9432,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

+
returns tunnel-xconnects
+

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects

Tags: Business
-

delete an existing relationship

+

returns tunnel-xconnects

-
- -

application/json application/xml -

-
@@ -9814,312 +9521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns tunnel-xconnects
-

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects

- Tags: - Business -
-
-
-

returns tunnel-xconnects

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- global-customer-id - -

Global customer id used across ECOMP to uniquely identify customer.

-
path - string - - - -
- service-type - -

Value defined by orchestration to identify this service across ECOMP.

-
path - string - - - -
- service-instance-id - -

Uniquely identifies this instance of a service

-
path - string - - - -
id -

Allotted Resource id UUID assigned to this instance.

-
path - string - - - -
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role - -

role in the network that this resource will be providing.

query @@ -10168,7 +9574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -10288,201 +9694,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role - -

role in the network that this resource will be providing.

-
query - string - - -
@@ -10522,7 +9733,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -10675,7 +9886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -10709,7 +9920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

tunnel-xconnect object that needs to be created or updated.

+

tunnel-xconnect object that needs to be updated.

@@ -10828,7 +10039,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -10985,7 +10196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11138,7 +10349,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11279,7 +10490,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11369,130 +10580,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status + metaname -

Orchestration status of this service.

query @@ -11541,7 +10631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11644,141 +10734,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

Subscriber type, a way to provide VID with only the INFRA customers.

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
@@ -11818,7 +10773,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11954,7 +10909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11988,7 +10943,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

@@ -12090,7 +11045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12230,7 +11185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12351,7 +11306,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12460,7 +11415,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12488,6 +11443,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns cloud-regions

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + + query + string + + +
+ cloud-region-id + + query + string + + +
+ cloud-type + + query + string + + +
+ owner-defined-type + + query + string + + +
+

application/json application/xml @@ -12524,7 +11550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12596,36 +11622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - -
@@ -12665,7 +11661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12770,7 +11766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12804,7 +11800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cloud-region object that needs to be created or updated.

+

cloud-region object that needs to be updated.

@@ -12875,7 +11871,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12984,7 +11980,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13058,25 +12054,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type + availability-zone-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -13125,7 +12105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13213,36 +12193,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - @@ -13282,7 +12232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13403,7 +12353,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13437,7 +12387,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

availability-zone object that needs to be created or updated.

+

availability-zone object that needs to be updated.

@@ -13524,7 +12474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13649,7 +12599,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13770,7 +12720,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13879,7 +12829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13953,10 +12903,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + switch-name -

Type of the cloud (e.g., openstack)

query @@ -13968,10 +12917,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + vcenter-url -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -14020,7 +12968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14108,51 +13056,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - - - - vcenter-url - - -

URL used to reach the vcenter

- - query - - string - - - - - @@ -14192,7 +13095,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14313,7 +13216,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14347,7 +13250,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

dvs-switch object that needs to be created or updated.

+

dvs-switch object that needs to be updated.

@@ -14434,7 +13337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14559,7 +13462,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14680,7 +13583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14789,7 +13692,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14863,10 +13766,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + flavor-id -

Type of the cloud (e.g., openstack)

query @@ -14878,10 +13780,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + flavor-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -14930,7 +13831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15018,49 +13919,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /flavor +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing flavor
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing flavor

+ +
+
+ +

application/json application/xml +

+
+
+

flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+
+ /flavor +
+
+
+
+
+ + + + + + + + + + + - + - + - + @@ -15072,29 +14072,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /flavor -
-
-
- -
default @@ -15102,7 +14079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15118,16 +14095,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing flavor
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+
update an existing flavor
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

Tags: CloudInfrastructure
-

create or update an existing flavor

+

update an existing flavor

@@ -15136,13 +14113,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

flavor object that needs to be updated.

@@ -15223,7 +14200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15239,34 +14216,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing flavor
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+
delete an existing flavor
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

Tags: CloudInfrastructure
-

update an existing flavor

+

delete an existing flavor

application/json application/xml

-
-
-

flavor object that needs to be created or updated.

-

-
-
-
-
- /flavor -
-
-
- cloud-type + cloud-owner -

Type of the cloud (e.g., openstack)

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- owner-defined-type + cloud-region-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- flavor-name + flavor-id -

Flavor name

+

Flavor id, expected to be unique across cloud-region.

querypath string +
@@ -15328,6 +14293,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -15344,7 +14325,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15359,23 +14340,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing flavor
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing flavor

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+ +
+
@@ -15437,14 +14430,107 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
- resource-version + cloud-owner -

resource-version for concurrency

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+
path string @@ -15469,7 +14555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15484,36 +14570,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns group-assignments
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns group-assignments

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

-

-
-
-
- -
-
-
@@ -15560,18 +14629,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -15583,6 +14678,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -15590,7 +14708,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15605,24 +14723,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns group-assignment
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns group-assignment

-
- -

application/json application/xml -

-
- flavor-id + group-id -

Flavor id, expected to be unique across cloud-region.

pathquery + string + + +
+ group-type + + query + string + + +
+ group-name + + query string -
@@ -15669,10 +14782,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- flavor-id + group-id -

Flavor id, expected to be unique across cloud-region.

+

Group id, expected to be unique across cloud-region.

path @@ -15692,6 +14805,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -15699,7 +14835,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15714,19 +14850,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns group-assignments
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

+
create or update an existing group-assignment
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

Tags: CloudInfrastructure
-

returns group-assignments

+

create or update an existing group-assignment

+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+
@@ -15773,32 +14926,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -15810,29 +14949,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -15840,7 +14956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15856,18 +14972,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns group-assignment
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
update an existing group-assignment
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

Tags: CloudInfrastructure
-

returns group-assignment

+

update an existing group-assignment

+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be updated.

+

+
+
+
+
+
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type + group-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Group id, expected to be unique across cloud-region.

querypath string +
@@ -15928,66 +15061,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- group-type - -

Group type - the type of group this instance refers to

-
query - string - - -
- group-name - -

Group name - name assigned to the group

-
query - string - - -
@@ -15997,29 +15070,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -16027,7 +15077,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16043,34 +15093,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing group-assignment
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
delete an existing group-assignment
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

Tags: CloudInfrastructure
-

create or update an existing group-assignment

+

delete an existing group-assignment

application/json application/xml

-
-
-

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

-

-
-
-
-
@@ -16132,6 +15170,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -16148,7 +15202,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16163,17 +15217,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing group-assignment
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing group-assignment

+

see node definition for valid relationships

@@ -16182,13 +15236,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

group-assignment object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

@@ -16269,7 +15323,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16284,17 +15338,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing group-assignment
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing group-assignment

+

delete an existing relationship

@@ -16302,143 +15356,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

application/json application/xml

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- group-id - -

Group id, expected to be unique across cloud-region.

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

-

-
-
-
- -
-
-
@@ -16515,7 +15432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16530,24 +15447,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+
returns images
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns images

-
- -

application/json application/xml -

-
@@ -16594,114 +15506,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- group-id + image-id -

Group id, expected to be unique across cloud-region.

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns images
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images

- Tags: - CloudInfrastructure -
-
-
-

returns images

- -
-
- - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner + image-name -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

pathquery string -
- cloud-region-id + application -

Identifier used by the vendor for the region. Second part of composite key

pathquery string -
- cloud-type + application-vendor -

Type of the cloud (e.g., openstack)

query @@ -16713,10 +15562,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + application-version -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -16765,7 +15613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16853,96 +15701,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- image-name - -

Image name

-
query - string - - -
- application - -

The application that the image instantiates.

-
query - string - - -
- application-vendor - -

The vendor of the application.

-
query - string - - -
- application-version - -

The version of the application.

-
query - string - - -
@@ -16982,7 +15740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17103,7 +15861,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17137,7 +15895,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

image object that needs to be created or updated.

+

image object that needs to be updated.

@@ -17224,7 +15982,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17349,7 +16107,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17439,85 +16197,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- image-name - -

Image name

-
query - string - - -
- application - -

The application that the image instantiates.

-
query - string - - -
- application-vendor - -

The vendor of the application.

-
query - string - - -
- application-version + metaname -

The version of the application.

query @@ -17566,7 +16248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17669,94 +16351,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + @@ -17768,29 +16519,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -17798,7 +16526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17814,16 +16542,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing metadatum
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+
update an existing metadatum
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

Tags: CloudInfrastructure
-

create or update an existing metadatum

+

update an existing metadatum

@@ -17832,13 +16560,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

+

metadatum object that needs to be updated.

@@ -17934,7 +16662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17950,152 +16678,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing metadatum
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

+
delete an existing metadatum
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

Tags: CloudInfrastructure
-

update an existing metadatum

- -
-
- -

application/json application/xml -

-
-
-

metadatum object that needs to be created or updated.

-

-
-
-
- -
-
-
-
-
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- image-name + cloud-owner -

Image name

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- application + cloud-region-id -

The application that the image instantiates.

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- application-vendor + image-id -

The vendor of the application.

+

Image id, expected to be unique across cloud region

querypath string +
- application-version + metaname -

The version of the application.

querypath string +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- image-id - -

Image id, expected to be unique across cloud region

-
path - string - - - -
- metaname - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing metadatum
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

- Tags: - CloudInfrastructure -
-
-
-

delete an existing metadatum

+

delete an existing metadatum

@@ -18210,7 +16802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18331,7 +16923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18440,7 +17032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18514,10 +17106,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + network-uuid -

Type of the cloud (e.g., openstack)

query @@ -18529,10 +17120,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + network-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -18542,6 +17132,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ cvlan-tag + + query + integer + + +
@@ -18581,7 +17185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18669,66 +17273,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - - - - network-name - - -

Name of the network.

- - query - - string - - - - - - - - cvlan-tag - - -

cvlan-id

- - query - - integer - - - - - @@ -18768,7 +17312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18889,7 +17433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18923,7 +17467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

oam-network object that needs to be created or updated.

+

oam-network object that needs to be updated.

@@ -19010,7 +17554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19135,7 +17679,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19256,7 +17800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19365,7 +17909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19470,7 +18014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19563,7 +18107,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19637,10 +18181,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + snapshot-id -

Type of the cloud (e.g., openstack)

query @@ -19652,10 +18195,65 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + snapshot-name + + + + query + + string + + + + + + + + application + + + + query + + string + + + + + + + + application-vendor + + + + query + + string + + + + + + + + application-version + + + + query + + string + + + + + + + + prev-snapshot-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -19704,7 +18302,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19792,111 +18390,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - - - - snapshot-name - - -

Snapshot name

- - query - - string - - - - - - - - application - - -

The application that the image instantiates.

- - query - - string - - - - - - - - application-vendor - - -

The vendor of the application.

- - query - - string - - - - - - - - application-version - - -

The version of the application.

- - query - - string - - - - - - - - prev-snapshot-id - - -

This field contains the UUID of the previous snapshot (if any).

- - query - - string - - - - - @@ -19936,7 +18429,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20057,7 +18550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20091,7 +18584,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

snapshot object that needs to be created or updated.

+

snapshot object that needs to be updated.

@@ -20178,7 +18671,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20303,7 +18796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20424,7 +18917,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20533,7 +19026,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20560,147 +19053,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns tenants

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /tenants -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns tenant
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

- Tags: - CloudInfrastructure -
-
-
-

returns tenant

-
@@ -20751,38 +19103,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen tenant-id - - - - - - - - - - - - - -
-

Unique id relative to the cloud-region.

-
path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -20797,7 +19117,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen tenant-name -

Readable name of tenant

query @@ -20811,6 +19130,133 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /tenants +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tenant
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns tenant

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+
+

application/json application/xml

@@ -20846,7 +19292,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20967,7 +19413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21001,7 +19447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

tenant object that needs to be created or updated.

+

tenant object that needs to be updated.

@@ -21088,7 +19534,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21213,7 +19659,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21334,7 +19780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21443,7 +19889,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21533,10 +19979,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + vserver-id -

Type of the cloud (e.g., openstack)

query @@ -21548,10 +19993,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + vserver-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -21563,10 +20007,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-name + vserver-name2 + + + + query + + string + + + + + + + + prov-status -

Readable name of tenant

query @@ -21576,6 +20033,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + in-maint + + + + query + + boolean + + + + + + + + is-closed-loop-disabled + + + + query + + boolean + + + + +
@@ -21615,7 +20100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21719,124 +20204,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - - - - tenant-name - - -

Readable name of tenant

- - query - - string - - - - - - - - vserver-name - - -

Name of vserver

- - query - - string - - - - - - - - vserver-name2 - - -

Alternative name of vserver

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - @@ -21876,7 +20243,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22013,7 +20380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22047,7 +20414,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vserver object that needs to be created or updated.

+

vserver object that needs to be updated.

@@ -22150,7 +20517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22291,7 +20658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22397,40 +20764,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

Type of the cloud (e.g., openstack)

- - query - - string - - - - - - - - owner-defined-type - - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- - query - - string - - - - - - - - tenant-name + interface-name -

Readable name of tenant

query @@ -22442,10 +20778,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vserver-name + interface-id -

Name of vserver

query @@ -22457,10 +20792,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vserver-name2 + macaddr -

Alternative name of vserver

query @@ -22472,10 +20806,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -22485,34 +20818,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - @@ -22552,7 +20857,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22672,167 +20977,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - + - + - + @@ -22844,29 +21162,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -22874,7 +21169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22890,16 +21185,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing l-interface
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+
update an existing l-interface
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

update an existing l-interface

@@ -22908,13 +21203,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

l-interface object that needs to be updated.

@@ -23027,7 +21322,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23043,34 +21338,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l-interface
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+
delete an existing l-interface
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

update an existing l-interface

+

delete an existing l-interface

application/json application/xml

-
-
-

l-interface object that needs to be created or updated.

-

-
-
-
- -
-
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 + cloud-owner -

Alternative name of vserver

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- prov-status + cloud-region-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + tenant-id -

ID of interface

+

Unique id relative to the cloud-region.

querypath string +
- macaddr + vserver-id -

MAC address for the interface

+

Unique identifier for this vserver relative to its tenant

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
@@ -23164,6 +21447,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -23180,7 +21479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23195,24 +21494,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing l-interface

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -23307,12 +21601,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -23330,6 +21624,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -23337,7 +21654,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23353,18 +21670,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
@@ -23473,214 +21807,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 - -

Alternative name of vserver

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -23690,29 +21816,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -23720,7 +21823,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23736,16 +21839,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing l3-interface-ipv4-address-list

@@ -23754,13 +21857,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -23889,7 +21992,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23905,34 +22008,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
@@ -24042,6 +22133,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -24058,7 +22165,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24073,23 +22180,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
@@ -24199,14 +22318,155 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
- resource-version + cloud-region-id -

resource-version for concurrency

+

Identifier used by the vendor for the region. Second part of composite key

querypath + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path string @@ -24231,7 +22491,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24246,36 +22506,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
@@ -24370,7 +22613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -24393,6 +22636,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -24400,7 +22666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24415,23 +22681,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -24527,7 +22805,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -24557,7 +22835,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24573,18 +22851,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
@@ -24693,205 +22988,169 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -24910,29 +23170,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -24940,7 +23177,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24955,17 +23192,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

@@ -24974,13 +23211,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -25109,7 +23346,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25124,35 +23361,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv6-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 + cloud-owner -

Alternative name of vserver

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- prov-status + cloud-region-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + tenant-id -

ID of interface

+

Unique id relative to the cloud-region.

querypath string +
- macaddr + vserver-id -

MAC address for the interface

+

Unique identifier for this vserver relative to its tenant

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + l3-interface-ipv6-address -

Neutron network id of the interface that address belongs to

+

IP address

querypath string +
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

query @@ -24899,6 +23158,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -25278,7 +23503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25293,23 +23518,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

+
+
+
+ +
+
@@ -25403,38 +23640,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -25451,7 +23656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25466,35 +23671,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
@@ -25588,22 +23781,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -25620,7 +23797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25635,24 +23812,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns sriov-vfs
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -25747,18 +23919,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -25770,6 +23996,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -25777,7 +24026,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25792,36 +24041,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
returns sriov-vf
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

-

-
-
-
- -
-
-
- l3-interface-ipv6-address + pci-id -

IP address

pathquery + string + + +
+ vf-vlan-filter + + query + string + + +
+ vf-mac-filter + + query + string + + +
+ vf-vlan-strip + + query + boolean + + +
+ neutron-network-id + + query string -
@@ -25914,6 +24146,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -25923,6 +24171,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -25930,7 +24201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25945,23 +24216,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -26055,6 +24338,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -26071,7 +24370,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26086,19 +24385,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

returns sriov-vfs

+

update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
@@ -26193,158 +24509,183 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type + pci-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - - - - - - - - - + - + @@ -26363,29 +24705,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -26393,7 +24712,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26408,19 +24727,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns sriov-vf

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
- tenant-name + cloud-owner -

Readable name of tenant

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- vserver-name + cloud-region-id -

Name of vserver

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- vserver-name2 + tenant-id -

Alternative name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- prov-status + vserver-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique identifier for this vserver relative to its tenant

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + pci-id -

MAC address for the interface

+

PCI ID used to identify the sriov-vf

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

query @@ -26352,6 +24693,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -26529,190 +24865,304 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + - + + +
- cloud-type + cloud-owner -

Type of the cloud (e.g., openstack)

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- owner-defined-type + cloud-region-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- tenant-name + tenant-id -

Readable name of tenant

+

Unique id relative to the cloud-region.

querypath string +
- vserver-name + vserver-id -

Name of vserver

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vserver-name2 + interface-name -

Alternative name of vserver

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - - - - - - - - + - + - + - + - + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + cloud-owner +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath - boolean + string +
- interface-id + cloud-region-id -

ID of interface

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- macaddr + tenant-id -

MAC address for the interface

+

Unique id relative to the cloud-region.

querypath string +
- network-name + vserver-id -

Name of the network

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name given to the interface

querypath string +
- vf-mac-filter + vlan-interface -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

query @@ -26724,14 +25174,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + vlan-id-inner -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

query - boolean + integer @@ -26739,10 +25188,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + vpn-id -

Neutron network id of the interface

query @@ -26778,7 +25226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -26791,7 +25239,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26806,36 +25254,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns vlan
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

returns vlan

-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
-
@@ -26930,10 +25361,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

path @@ -26953,6 +25384,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -26960,7 +25414,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26975,17 +25429,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing vlan
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

update an existing sriov-vf

+

create or update an existing vlan

@@ -26994,13 +25448,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

@@ -27099,10 +25553,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

path @@ -27129,7 +25583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27144,23 +25598,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing vlan
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -27256,10 +25722,167 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+
path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

path @@ -27302,7 +25925,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27317,36 +25940,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
- -
-
-
@@ -27441,10 +26047,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -27464,6 +26086,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -27471,7 +26116,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27486,23 +26131,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -27598,10 +26255,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -27628,7 +26301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27643,19 +26316,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

returns vlans

+

update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
+
@@ -27750,158 +26440,215 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- cloud-type + vlan-interface -

Type of the cloud (e.g., openstack)

+

String that identifies the interface

querypath string +
- owner-defined-type + l3-interface-ipv4-address -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - - + - + - + @@ -27920,29 +26668,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -27950,7 +26675,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27965,19 +26690,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns vlan

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
- tenant-name + cloud-owner -

Readable name of tenant

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- vserver-name + cloud-region-id -

Name of vserver

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- vserver-name2 + tenant-id -

Alternative name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- prov-status + vserver-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique identifier for this vserver relative to its tenant

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + interface-name +

Name given to the interface

querypath - boolean + string +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

query @@ -27909,6 +26656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -28088,195 +26830,359 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- cloud-type + l3-interface-ipv4-address -

Type of the cloud (e.g., openstack)

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + - + - + + +
- owner-defined-type + cloud-owner -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- tenant-name + cloud-region-id -

Readable name of tenant

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- vserver-name + tenant-id -

Name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- vserver-name2 + vserver-id -

Alternative name of vserver

+

Unique identifier for this vserver relative to its tenant

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name given to the interface

querypath string +
- in-maint + vlan-interface +

String that identifies the interface

querypath - boolean + string +
- is-closed-loop-disabled + l3-interface-ipv4-address +

IP address

querypath - boolean + string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + - + + + + + + + + + + + + + + + @@ -28305,7 +27211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -28318,7 +27224,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28333,17 +27239,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

create or update an existing vlan

+

create or update an existing l3-interface-ipv6-address-list

@@ -28352,13 +27258,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -28471,6 +27377,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- interface-id + cloud-owner -

ID of interface

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- macaddr + cloud-region-id -

MAC address for the interface

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- network-name + tenant-id -

Name of the network

+

Unique id relative to the cloud-region.

querypath string +
- vlan-id-inner + vserver-id -

Inner VLAN tag

+

Unique identifier for this vserver relative to its tenant

querypath - integer + string +
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -28487,7 +27409,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28502,17 +27424,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

update an existing vlan

+

update an existing l3-interface-ipv6-address-list

@@ -28521,13 +27443,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -28640,6 +27562,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -28656,7 +27594,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28671,17 +27609,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

delete an existing vlan

+

delete an existing l3-interface-ipv6-address-list

@@ -28797,6 +27735,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
resource-version @@ -28829,7 +27783,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28844,19 +27798,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
@@ -28967,7 +27938,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -28981,242 +27952,177 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + - + - + - - - - - - - - + - - - - - - - - + - + @@ -29228,29 +28134,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -29258,7 +28141,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29273,17 +28156,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -29292,13 +28175,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

@@ -29411,22 +28294,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 - -

Alternative name of vserver

-
query - string - - -
- prov-status + cloud-owner -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + cloud-region-id -

ID of interface

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- macaddr + tenant-id -

MAC address for the interface

+

Unique id relative to the cloud-region.

querypath string +
- network-name + vserver-id -

Name of the network

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -29443,7 +28310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29458,35 +28325,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv4-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
@@ -29596,22 +28451,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -29628,7 +28467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29643,23 +28482,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+ +
+
@@ -29737,70 +28588,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -29817,7 +28604,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29832,35 +28619,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
@@ -29938,54 +28713,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -30002,7 +28729,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30017,24 +28744,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns volumes
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns volumes

-
- -

application/json application/xml -

-
@@ -30113,50 +28835,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -30168,6 +28856,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volumes +
+
+
+ +
default @@ -30175,7 +28886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30190,17 +28901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns volume
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns volume

@@ -30281,42 +28992,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address + volume-id -

IP address

pathquery string -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -30327,244 +29006,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 - -

Alternative name of vserver

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -30591,7 +29032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -30604,7 +29045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30619,17 +29060,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing volume
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing volume

@@ -30638,13 +29079,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

@@ -30727,42 +29168,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -30789,7 +29198,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30804,17 +29213,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing volume
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv6-address-list

+

update an existing volume

@@ -30823,13 +29232,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

volume object that needs to be updated.

@@ -30912,42 +29321,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -30974,7 +29351,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30989,17 +29366,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing volume
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing volume

@@ -31085,42 +29462,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -31163,7 +29508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31178,11 +29523,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -31197,7 +29542,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

@@ -31286,42 +29631,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -31348,7 +29661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31363,11 +29676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -31459,42 +29772,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

path @@ -31521,7 +29802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31536,36 +29817,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns volume-groups
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns volume-groups

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
- -
-
-
@@ -31612,66 +29876,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + @@ -31683,6 +29939,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -31690,7 +29969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31705,24 +29984,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns volume-group
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns volume-group

-
- -

application/json application/xml -

-
- tenant-id + volume-group-id -

Unique id relative to the cloud-region.

pathquery string -
- vserver-id + volume-group-name -

Unique identifier for this vserver relative to its tenant

pathquery string -
- interface-name + heat-stack-id -

Name given to the interface

pathquery string -
- vlan-interface + vnf-type -

String that identifies the interface

pathquery string -
@@ -31769,10 +30043,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- tenant-id + volume-group-id -

Unique id relative to the cloud-region.

+

Unique ID of volume-group.

path @@ -31783,12 +30057,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing volume-group
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing volume-group

+ +
+
+ +

application/json application/xml +

+
+
+

volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
- vserver-id + cloud-owner -

Unique identifier for this vserver relative to its tenant

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

path @@ -31801,10 +30171,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name given to the interface

+

Identifier used by the vendor for the region. Second part of composite key

path @@ -31817,10 +30187,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + volume-group-id -

String that identifies the interface

+

Unique ID of volume-group.

path @@ -31847,7 +30217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31862,17 +30232,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

+
update an existing volume-group
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing volume-group

@@ -31881,13 +30251,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

volume-group object that needs to be updated.

@@ -31938,26 +30308,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id + volume-group-id -

Unique identifier for this vserver relative to its tenant

+

Unique ID of volume-group.

path @@ -31984,7 +30338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31999,17 +30353,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

+
delete an existing volume-group
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing volume-group

@@ -32063,10 +30417,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-id + volume-group-id -

Unique id relative to the cloud-region.

+

Unique ID of volume-group.

path @@ -32079,12 +30433,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-id + resource-version -

Unique identifier for this vserver relative to its tenant

+

resource-version for concurrency

pathquery string @@ -32109,7 +30463,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32124,19 +30478,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volumes
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns volumes

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+ +
+
+
@@ -32183,26 +30554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id + volume-group-id -

Unique identifier for this vserver relative to its tenant

+

Unique ID of volume-group.

path @@ -32213,124 +30568,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 - -

Alternative name of vserver

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
@@ -32340,29 +30577,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volumes -
-
-
- -
default @@ -32370,7 +30584,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32385,19 +30599,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns volume
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns volume

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -32444,42 +30663,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

-
path - string - - - -
- volume-id + volume-group-id -

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

path @@ -32490,124 +30677,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- tenant-name - -

Readable name of tenant

-
query - string - - -
- vserver-name - -

Name of vserver

-
query - string - - -
- vserver-name2 - -

Alternative name of vserver

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
@@ -32617,29 +30686,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volume -
-
-
- -
default @@ -32647,7 +30693,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32662,36 +30708,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing volume
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+
returns complexes
+

GET /cloud-infrastructure/complexes

Tags: CloudInfrastructure
-

create or update an existing volume

+

returns complexes

-
- -

application/json application/xml -

-
-
-

volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

-

-
-
-
-
- /volume -
-
-
-
@@ -32706,82 +30735,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + - + - + @@ -32793,6 +30798,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -32800,7 +30828,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32815,36 +30843,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing volume
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+
returns complex
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}

Tags: CloudInfrastructure
-

update an existing volume

+

returns complex

-
- -

application/json application/xml -

-
-
-

volume object that needs to be created or updated.

-

-
-
-
-
- /volume -
-
-
-
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id + physical-location-id -

Identifier used by the vendor for the region. Second part of composite key

pathquery string -
- tenant-id + data-center-code -

Unique id relative to the cloud-region.

pathquery string -
- vserver-id + complex-name -

Unique identifier for this vserver relative to its tenant

pathquery string -
- volume-id + identity-url -

Unique ID of block storage volume relative to the vserver.

pathquery string -
@@ -32859,74 +30870,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

-
path - string - - - -
- volume-id + physical-location-id -

Unique ID of block storage volume relative to the vserver.

+

Unique identifier for physical location, e.g., CLLI

path @@ -32946,6 +30893,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /complex +
+
+
+ +
default @@ -32953,7 +30923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32968,23 +30938,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing volume
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

+
create or update an existing complex
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

Tags: CloudInfrastructure
-

delete an existing volume

+

create or update an existing complex

application/json application/xml

+
+
+

complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+
+ /complex +
+
+
@@ -33000,74 +30982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

-
path - string - - - -
- volume-id + physical-location-id -

Unique ID of block storage volume relative to the vserver.

+

Unique identifier for physical location, e.g., CLLI

path @@ -33078,22 +30996,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -33110,7 +31012,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33125,17 +31027,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+
update an existing complex
+

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing complex

@@ -33144,13 +31046,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

complex object that needs to be updated.

@@ -33169,74 +31071,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

-
path - string - - - -
- volume-id + physical-location-id -

Unique ID of block storage volume relative to the vserver.

+

Unique identifier for physical location, e.g., CLLI

path @@ -33263,7 +31101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33278,17 +31116,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+
delete an existing complex
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing complex

@@ -33310,58 +31148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

-
path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id + physical-location-id -

Unique identifier for this vserver relative to its tenant

+

Unique identifier for physical location, e.g., CLLI

path @@ -33374,12 +31164,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + resource-version -

Unique ID of block storage volume relative to the vserver.

+

resource-version for concurrency

pathquery string @@ -33404,7 +31194,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33419,17 +31209,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume-groups
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

+
returns ctag-pools
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

Tags: CloudInfrastructure
-

returns volume-groups

+

returns ctag-pools

@@ -33446,26 +31236,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

-
path - string - - - -
- cloud-region-id + physical-location-id -

Identifier used by the vendor for the region. Second part of composite key

+

Unique identifier for physical location, e.g., CLLI

path @@ -33478,25 +31252,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type + availability-zone-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

query @@ -33532,7 +31290,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -33545,7 +31303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33560,17 +31318,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume-group
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+
returns ctag-pool
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

Tags: CloudInfrastructure
-

returns volume-group

+

returns ctag-pool

@@ -33587,10 +31345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -33603,10 +31361,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -33619,10 +31377,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -33633,81 +31391,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

Type of the cloud (e.g., openstack)

-
query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

-
query - string - - -
- volume-group-name - -

Name of the volume group.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this volume-group

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
@@ -33734,7 +31417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -33747,7 +31430,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33762,17 +31445,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing volume-group
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+
create or update an existing ctag-pool
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

Tags: CloudInfrastructure
-

create or update an existing volume-group

+

create or update an existing ctag-pool

@@ -33781,13 +31464,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

@@ -33806,10 +31489,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -33822,10 +31505,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -33838,10 +31521,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -33868,7 +31551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33883,17 +31566,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing volume-group
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+
update an existing ctag-pool
+

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

Tags: CloudInfrastructure
-

update an existing volume-group

+

update an existing ctag-pool

@@ -33902,13 +31585,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

volume-group object that needs to be created or updated.

+

ctag-pool object that needs to be updated.

@@ -33927,10 +31610,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -33943,10 +31626,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -33959,10 +31642,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -33989,7 +31672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34004,17 +31687,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing volume-group
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

+
delete an existing ctag-pool
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

Tags: CloudInfrastructure
-

delete an existing volume-group

+

delete an existing ctag-pool

@@ -34036,10 +31719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -34052,10 +31735,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -34068,10 +31751,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -34114,7 +31797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34129,11 +31812,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -34148,7 +31831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

@@ -34173,10 +31856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -34189,10 +31872,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -34205,10 +31888,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -34235,7 +31918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34250,11 +31933,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -34282,10 +31965,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Unique identifier for physical location, e.g., CLLI

path @@ -34298,10 +31981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

Identifier used by the vendor for the region. Second part of composite key

+

The Target provider edge router

path @@ -34314,10 +31997,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + availability-zone-name -

Unique ID of volume-group.

+

Name of the availability zone

path @@ -34344,7 +32027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34359,48 +32042,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns complexes
-

GET /cloud-infrastructure/complexes

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns complexes

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+
path + string + + + +
+

application/json application/xml

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -34408,7 +32116,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34423,19 +32131,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns complex
-

GET /cloud-infrastructure/complexes/complex/{physical-location-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns complex

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -34464,42 +32177,67 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profiles
+

GET /cloud-infrastructure/network-profiles

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profiles

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - + + + + + + + + + + + + + +
- data-center-code - -

Data center code which can be an alternate way to identify a complex

-
query - string - - -
- complex-name - -

Gamma complex name for LCP instance.

-
query - string - - -
- identity-url + nm-profile-name -

URL of the keystone identity service

query @@ -34535,7 +32273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -34548,7 +32286,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34563,36 +32301,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing complex
-

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

+
returns network-profile
+

GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

Tags: CloudInfrastructure
-

create or update an existing complex

+

returns network-profile

-
- -

application/json application/xml -

-
-
-

complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)

-

-
-
-
-
- /complex -
-
-
-
@@ -34607,10 +32328,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + nm-profile-name -

Unique identifier for physical location, e.g., CLLI

+

Unique name of network profile.

path @@ -34630,6 +32351,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -34637,7 +32381,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34652,17 +32396,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing complex
-

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

+
create or update an existing network-profile
+

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

Tags: CloudInfrastructure
-

update an existing complex

+

create or update an existing network-profile

@@ -34671,13 +32415,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

complex object that needs to be created or updated.

+

network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)

@@ -34696,10 +32440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + nm-profile-name -

Unique identifier for physical location, e.g., CLLI

+

Unique name of network profile.

path @@ -34726,7 +32470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34741,23 +32485,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing complex
-

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

+
update an existing network-profile
+

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

Tags: CloudInfrastructure
-

delete an existing complex

+

update an existing network-profile

application/json application/xml

+
+
+

network-profile object that needs to be updated.

+

+
+
+
+
@@ -34773,10 +32529,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- physical-location-id + nm-profile-name -

Unique identifier for physical location, e.g., CLLI

+

Unique name of network profile.

path @@ -34787,22 +32543,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -34819,7 +32559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34834,19 +32574,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pools
-

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

+
delete an existing network-profile
+

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

Tags: CloudInfrastructure
-

returns ctag-pools

+

delete an existing network-profile

+
+ +

application/json application/xml +

+
@@ -34861,10 +32606,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- physical-location-id + nm-profile-name -

Unique identifier for physical location, e.g., CLLI

+

Unique name of network profile.

path @@ -34877,10 +32622,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + resource-version -

Data center code which can be an alternate way to identify a complex

+

resource-version for concurrency

query @@ -34888,36 +32633,173 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + + +
- complex-name + nm-profile-name -

Gamma complex name for LCP instance.

+

Unique name of network profile.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + @@ -34929,29 +32811,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -34959,7 +32818,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34974,17 +32833,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pool
-

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+
returns pservers
+

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure
-

returns ctag-pool

+

returns pservers

@@ -35001,62 +32860,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + - + - + + +
- identity-url + nm-profile-name -

URL of the keystone identity service

+

Unique name of network profile.

querypath string +
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

pathquery string -
- target-pe + inv-status -

The Target provider edge router

pathquery string -
- availability-zone-name + pserver-id -

Name of the availability zone

pathquery string -
- data-center-code + in-maint -

Data center code which can be an alternate way to identify a complex

query - string + boolean @@ -35064,10 +32916,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- complex-name + pserver-name2 -

Gamma complex name for LCP instance.

query @@ -35077,19 +32928,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pserver
+

GET /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

returns pserver

+ +
+
+ + + + + + + + + + + - + @@ -35118,7 +33049,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -35131,7 +33062,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35146,17 +33077,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing ctag-pool
-

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+
create or update an existing pserver
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}

Tags: CloudInfrastructure
-

create or update an existing ctag-pool

+

create or update an existing pserver

@@ -35165,13 +33096,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)

@@ -35190,42 +33121,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - + +
- identity-url + hostname -

URL of the keystone identity service

+

Value from executing hostname on the compute node.

querypath string +
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

-
path - string - - - -
- availability-zone-name + hostname -

Name of the availability zone

+

Value from executing hostname on the compute node.

path @@ -35252,7 +33151,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35267,17 +33166,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing ctag-pool
-

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+
update an existing pserver
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

Tags: CloudInfrastructure
-

update an existing ctag-pool

+

update an existing pserver

@@ -35286,13 +33185,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ctag-pool object that needs to be created or updated.

+

pserver object that needs to be updated.

@@ -35311,10 +33210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

+

Value from executing hostname on the compute node.

path @@ -35325,12 +33224,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing pserver
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
- target-pe + hostname -

The Target provider edge router

+

Value from executing hostname on the compute node.

path @@ -35343,12 +33303,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + resource-version -

Name of the availability zone

+

resource-version for concurrency

pathquery string @@ -35373,7 +33333,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35388,24 +33348,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ctag-pool
-

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+
returns lag-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

Tags: CloudInfrastructure
-

delete an existing ctag-pool

+

returns lag-interfaces

-
- -

application/json application/xml -

-
@@ -35420,10 +33375,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -35491,6 +33440,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -35498,7 +33470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35513,36 +33485,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

+
returns lag-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns lag-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

-

-
-
-
- -
-
-
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

+

Value from executing hostname on the compute node.

path @@ -35436,42 +33391,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + interface-name -

The Target provider edge router

pathquery string -
- availability-zone-name + interface-id -

Name of the availability zone

pathquery string -
- resource-version + interface-role -

resource-version for concurrency

query @@ -35479,7 +33429,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -35557,26 +33512,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - -
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe + hostname -

The Target provider edge router

+

Value from executing hostname on the compute node.

path @@ -35589,10 +33528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + interface-name -

Name of the availability zone

+

Name that identifies the link aggregate interface

path @@ -35612,6 +33551,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -35619,7 +33581,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35634,23 +33596,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

+
create or update an existing lag-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
@@ -35666,26 +33640,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe + hostname -

The Target provider edge router

+

Value from executing hostname on the compute node.

path @@ -35698,10 +33656,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + interface-name -

Name of the availability zone

+

Name that identifies the link aggregate interface

path @@ -35728,7 +33686,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35743,17 +33701,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

+
update an existing lag-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -35762,13 +33720,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)

+

lag-interface object that needs to be updated.

@@ -35787,10 +33745,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

+

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

path @@ -35817,7 +33791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35832,17 +33806,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

+
delete an existing lag-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing lag-interface

@@ -35864,10 +33838,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

+

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

path @@ -35878,6 +33868,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -35894,7 +33900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35909,19 +33915,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns network-profiles
-

GET /cloud-infrastructure/network-profiles

+
returns l-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: CloudInfrastructure
-

returns network-profiles

+

returns l-interfaces

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + + query + string + + +
+ interface-id + + query + string + + +
+ macaddr + + query + string + + +
+ network-name + + query + string + + +
+

application/json application/xml @@ -35945,7 +34054,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

@@ -35958,7 +34067,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35973,17 +34082,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns network-profile
-

GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+
returns l-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

returns network-profile

+

returns l-interface

@@ -36000,10 +34109,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + hostname -

Unique name of network profile.

+

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -36040,7 +34181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -36053,7 +34194,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36068,17 +34209,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing network-profile
-

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing network-profile

+

create or update an existing l-interface

@@ -36087,13 +34228,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -36112,10 +34253,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + hostname -

Unique name of network profile.

+

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -36142,7 +34315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36157,17 +34330,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing network-profile
-

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

update an existing network-profile

+

update an existing l-interface

@@ -36176,13 +34349,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

network-profile object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -36201,10 +34374,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + hostname -

Unique name of network profile.

+

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -36231,7 +34436,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36246,17 +34451,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing network-profile
-

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing network-profile

+

delete an existing l-interface

@@ -36278,10 +34483,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + hostname -

Unique name of network profile.

+

Value from executing hostname on the compute node.

path @@ -36294,12 +34499,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -36308,85 +34513,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - -
- nm-profile-name + interface-name -

Unique name of network profile.

+

Name given to the interface

path @@ -36397,75 +34529,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - + - + - - - - - - - - + @@ -36695,7 +34691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -36708,7 +34704,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36723,17 +34719,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing pserver
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

create or update an existing pserver

+

create or update an existing l3-interface-ipv4-address-list

@@ -36742,13 +34738,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -36781,6 +34777,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + +
- nm-profile-name + resource-version -

Unique name of network profile.

+

resource-version for concurrency

pathquery string @@ -36490,71 +34561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - - - - - -
-
-
returns pservers
-

GET /cloud-infrastructure/pservers

- Tags: - CloudInfrastructure -
-
-
-

returns pservers

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /pservers -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36569,17 +34576,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pserver
-

GET /cloud-infrastructure/pservers/pserver/{hostname}

+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

returns pserver

+

returns l3-interface-ipv4-address-list

@@ -36612,61 +34619,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + l3-interface-ipv4-address -

alternative pserver name

+

IP address

querypath string +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -36797,7 +34841,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36812,17 +34856,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing pserver
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

update an existing pserver

+

update an existing l3-interface-ipv4-address-list

@@ -36831,13 +34875,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

pserver object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -36870,6 +34914,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -36886,7 +34978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36901,17 +34993,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing pserver
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing pserver

+

delete an existing l3-interface-ipv4-address-list

@@ -36947,6 +35039,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
resource-version @@ -36979,7 +35119,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36994,19 +35134,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns lag-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -37037,61 +35194,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - - - - - - - - + @@ -37103,29 +35249,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -37133,7 +35256,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37148,19 +35271,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interface
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns lag-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + l3-interface-ipv4-address -

alternative pserver name

+

IP address

querypath string +
@@ -37207,91 +35335,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath string +
- pserver-id + l3-interface-ipv4-address -

ID of Pserver

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -37320,7 +35511,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -37333,7 +35524,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37348,17 +35539,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

create or update an existing lag-interface

+

create or update an existing l3-interface-ipv6-address-list

@@ -37367,13 +35558,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -37422,6 +35613,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- in-maint + hostname +

Value from executing hostname on the compute node.

querypath - boolean + string +
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + l3-interface-ipv6-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -37438,7 +35661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37453,17 +35676,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing lag-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

update an existing lag-interface

+

update an existing l3-interface-ipv6-address-list

@@ -37472,13 +35695,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -37527,6 +35750,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -37543,7 +35798,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37558,17 +35813,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

delete an existing lag-interface

+

delete an existing l3-interface-ipv6-address-list

@@ -37620,6 +35875,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
resource-version @@ -37652,7 +35939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37667,19 +35954,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
@@ -37726,91 +36030,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath string +
- pserver-id + l3-interface-ipv6-address -

ID of Pserver

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + @@ -37822,29 +36194,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -37852,7 +36201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37867,19 +36216,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l-interface

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
- in-maint + hostname +

Value from executing hostname on the compute node.

querypath - boolean + string +
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + l3-interface-ipv6-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
@@ -37940,86 +36306,224 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - - - - - - - - + - - +
- inv-status + hostname -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Value from executing hostname on the compute node.

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name that identifies the link aggregate interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name given to the interface

querypath string +
- interface-id +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- interface-role + interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -38031,10 +36535,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-vlan-filter -

ID of interface

query @@ -38046,10 +36549,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-mac-filter -

MAC address for the interface

query @@ -38061,10 +36563,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vf-vlan-strip + + query + boolean + + +
+ neutron-network-id -

Name of the network

query @@ -38100,7 +36615,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -38113,7 +36628,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38128,36 +36643,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns sriov-vf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
-
@@ -38218,6 +36716,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -38227,6 +36741,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -38234,7 +36771,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38249,17 +36786,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

update an existing l-interface

+

create or update an existing sriov-vf

@@ -38268,13 +36805,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -38339,6 +36876,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -38355,7 +36908,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38370,23 +36923,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

delete an existing l-interface

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -38450,12 +37015,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - + + + + + + +
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -38480,7 +37045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38495,19 +37060,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
@@ -38570,10 +37140,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -38772,29 +37179,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -38802,7 +37186,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38817,17 +37201,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -38836,13 +37220,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -38909,10 +37293,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - -
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -38586,174 +37156,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

query @@ -38761,6 +37167,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -38939,7 +37323,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38954,35 +37338,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv4-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
@@ -39046,10 +37418,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -39076,7 +37448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39091,24 +37463,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

returns vlans

-
- -

application/json application/xml -

-
@@ -39171,10 +37538,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + +
- l3-interface-ipv4-address + vlan-interface + + query + string + + +
+ vlan-id-inner + + query + integer + + +
+ vpn-id -

IP address

+
query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + - + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+ hostname + +

Value from executing hostname on the compute node.

path @@ -39187,12 +37675,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path string @@ -39210,6 +37730,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -39217,7 +37760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39232,17 +37775,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing vlan

@@ -39251,13 +37794,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -39324,10 +37867,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

path @@ -39354,7 +37897,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39369,23 +37912,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -39449,10 +38004,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

path @@ -39479,7 +38034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39494,19 +38049,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing vlan
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

delete an existing vlan

+
+ +

application/json application/xml +

+
@@ -39569,10 +38129,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- l3-interface-ipv6-address + vlan-interface -

IP address

+

String that identifies the interface

path @@ -39585,84 +38145,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role + resource-version -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

resource-version for concurrency

query @@ -39670,96 +38156,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - - - - + - + @@ -39788,7 +38321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -39801,7 +38334,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39816,17 +38349,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -39835,13 +38368,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -39908,7 +38441,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -
- interface-id + hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -39938,7 +38487,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39953,17 +38502,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

@@ -39972,13 +38521,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -40045,7 +38594,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -40075,7 +38640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40090,17 +38655,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing l3-interface-ipv4-address-list

@@ -40170,7 +38735,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -40216,7 +38797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40231,11 +38812,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40250,7 +38831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -40323,7 +38904,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -40353,7 +38950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40368,11 +38965,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40448,7 +39045,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -40478,7 +39091,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40493,36 +39106,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
-
@@ -40583,6 +39179,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -40592,6 +39220,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -40599,7 +39250,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40614,23 +39265,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -40692,6 +39355,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -40708,7 +39403,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40723,19 +39418,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

returns sriov-vfs

+

update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
@@ -40798,136 +39510,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -40939,29 +39549,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -40969,7 +39556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40984,19 +39571,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

returns sriov-vf

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -41059,10 +39651,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

path @@ -41075,99 +39667,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role + l3-interface-ipv6-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
- interface-id + resource-version -

ID of interface

+

resource-version for concurrency

query @@ -41175,96 +39694,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - - + @@ -41276,29 +39859,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -41306,7 +39866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41321,35 +39881,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

delete an existing relationship

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
- macaddr + hostname -

MAC address for the interface

+

Value from executing hostname on the compute node.

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the link aggregate interface

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name given to the interface

querypath string +
- vf-mac-filter + vlan-interface -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

String that identifies the interface

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
@@ -41413,10 +39961,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - -
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -41443,7 +40007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41458,17 +40022,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing sriov-vf

+

see node definition for valid relationships

@@ -41477,13 +40041,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -41550,10 +40114,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

path @@ -41580,7 +40144,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41595,17 +40159,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -41675,10 +40239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

path @@ -41689,22 +40253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -41721,7 +40269,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41736,11 +40284,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -41755,7 +40303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

@@ -41810,38 +40358,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -41858,7 +40374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41873,11 +40389,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -41935,38 +40451,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -41983,7 +40467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41998,17 +40482,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns p-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

Tags: CloudInfrastructure
-

returns vlans

+

returns p-interfaces

@@ -42044,128 +40528,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

query @@ -42177,25 +40539,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + prov-status -

Name of the network

query @@ -42231,7 +40577,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -42244,7 +40590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42259,17 +40605,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns p-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

Tags: CloudInfrastructure
-

returns vlan

+

returns p-interface

@@ -42305,39 +40651,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

+

Name that identifies the physical interface

path @@ -42348,170 +40662,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -42538,7 +40688,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -42551,7 +40701,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42566,17 +40716,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing p-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing vlan

+

create or update an existing p-interface

@@ -42585,13 +40735,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

@@ -42629,39 +40779,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

+

Name that identifies the physical interface

path @@ -42688,7 +40806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42703,17 +40821,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing p-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

Tags: CloudInfrastructure
-

update an existing vlan

+

update an existing p-interface

@@ -42722,13 +40840,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

p-interface object that needs to be updated.

@@ -42766,39 +40884,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

+

Name that identifies the physical interface

path @@ -42825,7 +40911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42840,17 +40926,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing p-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing vlan

+

delete an existing p-interface

@@ -42891,39 +40977,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

+

Name that identifies the physical interface

path @@ -42966,7 +41020,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42981,17 +41035,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

returns l-interfaces

@@ -43027,7 +41081,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -43043,129 +41097,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -43180,7 +41111,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -43195,7 +41125,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen macaddr -

MAC address for the interface

query @@ -43210,7 +41139,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

query @@ -43220,79 +41148,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - + - + @@ -43321,7 +41301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -43334,7 +41314,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43349,17 +41329,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing l-interface

@@ -43368,13 +41348,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

@@ -43412,7 +41392,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - - - - - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + hostname -

This indicates the customers VPN ID associated with this vlan

+

Value from executing hostname on the compute node.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name that identifies the physical interface

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name given to the interface

querypath string +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -43439,38 +41419,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -43487,7 +41435,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43502,17 +41450,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv4-address-list

+

update an existing l-interface

@@ -43521,13 +41469,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -43565,7 +41513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -43592,38 +41540,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -43640,7 +41556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43655,17 +41571,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing l-interface

@@ -43706,7 +41622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -43733,38 +41649,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
resource-version @@ -43797,7 +41681,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43812,36 +41696,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
@@ -43875,7 +41742,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -47439,7 +45454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47454,11 +45469,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
@@ -47473,7 +45488,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -47544,6 +45559,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -48423,7 +46370,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48438,11 +46385,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -48457,7 +46404,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -48528,6 +46475,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -43902,22 +41769,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -43943,14 +41794,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- default +
+ 200 OK
-
+
-

Response codes found in response codes.

+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

@@ -43965,23 +41839,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -44016,7 +41902,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -44043,22 +41929,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -44091,7 +41961,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44106,19 +41976,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
+
@@ -44152,7 +42039,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -44181,10 +42068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

path @@ -44195,12 +42082,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- l3-interface-ipv6-address + hostname -

IP address

+

Value from executing hostname on the compute node.

path @@ -44213,54 +42161,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the physical interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint + l3-interface-ipv4-address +

IP address

querypath - boolean + string +
- pserver-name2 + resource-version -

alternative pserver name

+

resource-version for concurrency

query @@ -44268,156 +42220,389 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- interface-id + hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name that identifies the physical interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + + +
- network-name + hostname -

Name of the network

+

Value from executing hostname on the compute node.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the physical interface

querypath - integer + string +
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string +
- vlan-id-inner + l3-interface-ipv4-address -

Inner VLAN tag

+

IP address

querypath - integer + string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -44459,7 +42644,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44474,11 +42659,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -44493,7 +42678,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -44537,7 +42722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- neutron-network-id + hostname -

Neutron network id of the interface that address belongs to

+

Value from executing hostname on the compute node.

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path string +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -44564,22 +42749,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -44612,7 +42781,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44627,11 +42796,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -44646,7 +42815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -44690,7 +42859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -44717,22 +42886,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -44765,7 +42918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44780,11 +42933,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -44831,7 +42984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -44858,22 +43011,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -44922,7 +43059,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44937,11 +43074,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -44956,7 +43093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -45000,7 +43137,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -45027,22 +43164,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -45075,7 +43196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45090,11 +43211,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -45141,7 +43262,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -45168,22 +43289,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -45216,7 +43321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45231,11 +43336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -45250,7 +43355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

@@ -45294,7 +43399,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -45321,22 +43426,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
@@ -45353,7 +43442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45368,11 +43457,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -45419,7 +43508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -45446,22 +43535,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
@@ -45478,7 +43551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45493,36 +43566,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+
returns sriov-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns sriov-vfs

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

-

-
-
-
- -
-
-
@@ -45556,7 +43612,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

path @@ -45567,73 +43623,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -45669,6 +43718,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -45676,7 +43748,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45691,17 +43763,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interfaces
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

+
returns sriov-vf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

returns p-interfaces

+

returns sriov-vf

@@ -45734,61 +43806,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + - + - - - - - - - - + @@ -45817,7 +43878,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -45830,7 +43891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -45845,19 +43906,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interface
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

returns p-interface

+

create or update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
- hostname + interface-name -

Value from executing hostname on the compute node.

+

Name given to the interface

path @@ -45646,18 +43641,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name that identifies the link aggregate interface

pathquery + string + + +
+ vf-vlan-filter + + query + string + + +
+ vf-mac-filter + + query + string + + +
+ vf-vlan-strip + + query + boolean + + +
+ neutron-network-id + + query string -
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the physical interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + pci-id -

alternative pserver name

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -45904,76 +43982,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -45985,29 +44021,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -46015,7 +44028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46030,17 +44043,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

create or update an existing p-interface

+

update an existing sriov-vf

@@ -46049,13 +44062,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

sriov-vf object that needs to be updated.

@@ -46104,6 +44117,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

querypath string +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -46120,7 +44165,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46135,35 +44180,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing p-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
delete an existing sriov-vf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

update an existing p-interface

+

delete an existing sriov-vf

application/json application/xml

-
-
-

p-interface object that needs to be created or updated.

-

-
-
-
- -
-
@@ -46209,6 +44242,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -46225,7 +44306,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46240,23 +44321,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing p-interface
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing p-interface

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
@@ -46304,12 +44397,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + +
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path string @@ -46334,7 +44443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46349,19 +44458,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l-interfaces

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -46408,76 +44522,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -46489,29 +44561,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -46519,7 +44568,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46534,17 +44583,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: CloudInfrastructure
-

returns l-interface

+

returns vlans

@@ -46609,25 +44658,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

querypath string +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id + vlan-interface -

ID of Pserver

query @@ -46639,13 +44672,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + vlan-id-inner query - boolean + integer @@ -46653,10 +44686,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + vpn-id -

alternative pserver name

query @@ -46666,64 +44698,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -46752,7 +44867,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -46765,7 +44880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46780,17 +44895,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

create or update an existing vlan

@@ -46799,13 +44914,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -46870,6 +44985,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- prov-status + hostname -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Value from executing hostname on the compute node.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the physical interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + vlan-interface -

Name of the network

+

String that identifies the interface

querypath string +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -46886,7 +45017,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -46901,17 +45032,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

update an existing l-interface

+

update an existing vlan

@@ -46920,13 +45051,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -46991,6 +45122,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -47007,7 +45154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47022,17 +45169,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
delete an existing vlan
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

delete an existing l-interface

+

delete an existing vlan

@@ -47100,6 +45247,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
resource-version @@ -47132,7 +45295,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47147,11 +45310,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
@@ -47222,10 +45385,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

path @@ -47238,166 +45401,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id + l3-interface-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv4-address @@ -47576,7 +45607,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47591,11 +45622,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
@@ -47610,7 +45641,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -47681,6 +45712,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv4-address @@ -47713,7 +45760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47728,11 +45775,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
@@ -47806,6 +45853,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv4-address @@ -47854,7 +45917,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -47869,11 +45932,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -47888,7 +45951,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -47959,6 +46022,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv4-address @@ -47991,7 +46070,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48006,11 +46085,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -48084,6 +46163,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv4-address @@ -48116,7 +46211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48131,11 +46226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -48206,10 +46301,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface -

IP address

+

String that identifies the interface

path @@ -48222,166 +46317,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv6-address @@ -48560,7 +46523,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48575,11 +46538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -48594,7 +46557,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -48665,6 +46628,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv6-address @@ -48697,7 +46676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48712,11 +46691,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -48790,6 +46769,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv6-address @@ -48838,7 +46833,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48853,11 +46848,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -48872,7 +46867,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -48943,6 +46938,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv6-address @@ -48975,7 +46986,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -48990,11 +47001,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -49068,6 +47079,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
l3-interface-ipv6-address @@ -49100,7 +47127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49115,11 +47142,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -49134,7 +47161,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -49205,6 +47232,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -49221,7 +47264,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49236,11 +47279,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -49314,6 +47357,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -49330,7 +47389,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49345,19 +47404,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns sriov-vfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
@@ -49402,141 +47478,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
@@ -49546,29 +47487,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -49576,7 +47494,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49591,19 +47509,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns sriov-vf

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -49648,12 +47571,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + +
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

path @@ -49664,12 +47660,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + +
- pci-id + hostname -

PCI ID used to identify the sriov-vf

+

Value from executing hostname on the compute node.

path @@ -49680,131 +47737,67 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-centers
+

GET /cloud-infrastructure/virtual-data-centers

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-centers

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter + vdc-id -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

query @@ -49816,10 +47809,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vdc-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

query @@ -49829,34 +47821,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-center
+

GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-center

+ +
+
+ + + + + + + + + + + - - - - - - - - + @@ -49885,7 +47942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -49898,7 +47955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49913,17 +47970,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing virtual-data-center
+

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

create or update an existing virtual-data-center

@@ -49932,13 +47989,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

@@ -49957,58 +48014,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id + vdc-id -

Neutron network id of the interface

+

Unique ID of the vdc

querypath string +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id + vdc-id -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

path @@ -50035,7 +48044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50050,17 +48059,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing virtual-data-center
+

PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure
-

update an existing sriov-vf

+

update an existing virtual-data-center

@@ -50069,13 +48078,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

virtual-data-center object that needs to be updated.

@@ -50094,58 +48103,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id + vdc-id -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

path @@ -50172,7 +48133,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50187,17 +48148,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing virtual-data-center
+

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

delete an existing virtual-data-center

@@ -50219,58 +48180,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id + vdc-id -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

path @@ -50313,7 +48226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50328,11 +48241,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -50347,7 +48260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

@@ -50372,58 +48285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id + vdc-id -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

path @@ -50450,7 +48315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50465,11 +48330,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -50497,58 +48362,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id + vdc-id -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

path @@ -50575,7 +48392,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50590,17 +48407,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns generic-vnfs
+

GET /network/generic-vnfs

Tags: - CloudInfrastructure + Network
-

returns vlans

+

returns generic-vnfs

@@ -50617,58 +48434,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

pathquery string -
- interface-name + vnf-name -

Name given to the interface

pathquery string -
- inv-status + vnf-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -50680,10 +48476,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + vnf-type -

ID of Pserver

query @@ -50695,13 +48490,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + service-id query - boolean + string @@ -50709,10 +48504,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + regional-resource-zone -

alternative pserver name

query @@ -50727,7 +48521,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -50739,10 +48532,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + heat-stack-id -

ID of interface

query @@ -50754,14 +48546,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + in-maint -

MAC address for the interface

query - string + boolean @@ -50769,168 +48560,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + is-closed-loop-disabled -

Name of the network

query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlan
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - CloudInfrastructure -
-
-
-

returns vlan

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string + boolean -
- inv-status + model-invariant-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -50942,10 +48588,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + model-version-id -

ID of Pserver

query @@ -50957,24 +48602,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- pserver-name2 + widget-model-id -

alternative pserver name

query @@ -50986,10 +48616,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + widget-model-version -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -51001,10 +48630,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + nf-type -

ID of interface

query @@ -51016,10 +48644,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + nf-function -

MAC address for the interface

query @@ -51031,10 +48658,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + nf-role -

Name of the network

query @@ -51046,25 +48672,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + nf-naming-code -

This indicates the customers VPN ID associated with this vlan

query @@ -51100,7 +48710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -51113,7 +48723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51128,36 +48738,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns generic-vnf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: - CloudInfrastructure + Network
-

create or update an existing vlan

+

returns generic-vnf

-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
-
- /vlan -
-
-
-
@@ -51172,58 +48765,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname + vnf-id -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51243,6 +48788,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -51250,7 +48818,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51265,17 +48833,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing generic-vnf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: - CloudInfrastructure + Network
-

update an existing vlan

+

create or update an existing generic-vnf

@@ -51284,13 +48852,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

@@ -51309,58 +48877,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51387,7 +48907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51402,23 +48922,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing generic-vnf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: - CloudInfrastructure + Network
-

delete an existing vlan

+

update an existing generic-vnf

application/json application/xml

+
+
+

generic-vnf object that needs to be updated.

+

+
+
+
+ +
+
@@ -51434,42 +48966,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51480,12 +48980,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing generic-vnf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51528,7 +49089,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51543,17 +49104,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns entitlements
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

Tags: - CloudInfrastructure + Network
-

returns l3-interface-ipv4-address-list

+

returns entitlements

@@ -51570,10 +49131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

path @@ -51586,42 +49147,117 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

pathquery string -
- interface-name + resource-uuid -

Name given to the interface

pathquery string -
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns entitlement

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -51868,7 +49326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -51881,7 +49339,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51896,17 +49354,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing entitlement
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: - CloudInfrastructure + Network
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing entitlement

@@ -51915,13 +49373,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

@@ -51940,42 +49398,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51634,10 +49270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + group-uuid -

IP address

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -51650,196 +49286,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id + resource-uuid -

Neutron id of subnet that address belongs to

+

Unique ID of an entitlement resource.

querypath string +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -51988,10 +49414,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + group-uuid -

String that identifies the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -52004,10 +49430,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

path @@ -52034,7 +49460,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52049,17 +49475,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing entitlement
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: - CloudInfrastructure + Network
-

update an existing l3-interface-ipv4-address-list

+

update an existing entitlement

@@ -52068,13 +49494,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

entitlement object that needs to be updated.

@@ -52093,42 +49519,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -52141,10 +49535,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + group-uuid -

String that identifies the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -52157,10 +49551,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

path @@ -52187,7 +49581,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52202,17 +49596,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing entitlement
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: - CloudInfrastructure + Network
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing entitlement

@@ -52234,42 +49628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -52282,10 +49644,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + group-uuid -

String that identifies the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -52298,10 +49660,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

path @@ -52344,7 +49706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52359,13 +49721,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
@@ -52378,7 +49740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

@@ -52403,10 +49765,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

path @@ -52419,10 +49781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -52435,10 +49797,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of an entitlement resource.

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + - - - - - - -
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

path @@ -52451,10 +49890,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + group-uuid -

String that identifies the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

path @@ -52467,10 +49906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

path @@ -52497,7 +49936,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52512,24 +49951,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

Tags: - CloudInfrastructure + Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -52544,10 +49978,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + @@ -52631,6 +50057,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -52638,7 +50087,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52653,17 +50102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: - CloudInfrastructure + Network
-

returns l3-interface-ipv6-address-list

+

returns l-interface

@@ -52680,26 +50129,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - + +
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

path @@ -52563,63 +49997,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

pathquery string -
- interface-name + interface-id -

Name given to the interface

pathquery string -
- vlan-interface + macaddr -

String that identifies the interface

pathquery string -
- l3-interface-ipv4-address + network-name -

IP address

pathquery string -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -52726,12 +50159,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + +
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

path @@ -52744,10 +50273,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name given to the interface

path @@ -52758,116 +50287,210 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 + vnf-id -

alternative pserver name

+

Unique id of VNF. This is unique across the graph.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name given to the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

query @@ -52875,81 +50498,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - + - + @@ -52978,7 +50631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -52991,7 +50644,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53006,17 +50659,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: - CloudInfrastructure + Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -53025,13 +50678,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -53050,26 +50703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + vnf-id -

This indicates the customers VPN ID associated with this vlan

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53098,23 +50735,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -53144,7 +50765,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53159,17 +50780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: - CloudInfrastructure + Network
-

update an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

@@ -53178,13 +50799,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -53203,26 +50824,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53251,23 +50856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -53297,7 +50886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53312,17 +50901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: - CloudInfrastructure + Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing l3-interface-ipv4-address-list

@@ -53344,26 +50933,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53392,23 +50965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -53454,7 +51011,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53469,13 +51026,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
@@ -53488,7 +51045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -53513,26 +51070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53561,23 +51102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -53607,7 +51132,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53622,13 +51147,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
@@ -53654,26 +51179,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53702,23 +51211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -53748,7 +51241,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53763,36 +51256,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: - CloudInfrastructure + Network
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
- -
-
-
@@ -53807,26 +51283,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + + +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53855,10 +51315,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

path @@ -53878,6 +51338,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -53885,7 +51368,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53900,23 +51383,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: - CloudInfrastructure + Network
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -53932,26 +51427,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

path @@ -53980,10 +51459,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

path @@ -54010,7 +51489,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54025,17 +51504,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: - CloudInfrastructure + Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -54044,13 +51523,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -54069,10 +51548,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

path @@ -54088,7 +51567,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -54115,7 +51610,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54130,17 +51625,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: - CloudInfrastructure + Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -54162,10 +51657,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

path @@ -54181,7 +51676,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -54192,6 +51703,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -54208,7 +51735,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54223,13 +51750,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
@@ -54242,7 +51769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -54267,10 +51794,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -54297,7 +51856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54312,13 +51871,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
@@ -54344,10 +51903,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + vnf-id -

Value from executing hostname on the compute node.

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -54374,7 +51965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54389,83 +51980,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns virtual-data-centers
-

GET /cloud-infrastructure/virtual-data-centers

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
-

returns virtual-data-centers

+

see node definition for valid relationships

- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

- -
-
-
-
-
- - -
-
-
returns virtual-data-center
-

GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

- Tags: - CloudInfrastructure -
-
-
-

returns virtual-data-center

- -
+
+
+ +
+
+
@@ -54480,10 +52024,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -54518,29 +52063,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
default @@ -54548,7 +52070,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54563,35 +52085,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing virtual-data-center
-

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: - CloudInfrastructure + Network
-

create or update an existing virtual-data-center

+

delete an existing relationship

application/json application/xml

-
-
-

virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

-

-
- -
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

path @@ -54496,17 +52040,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-name + interface-name -

Name of the virtual data center

+

Name given to the interface

querypath string +
@@ -54607,10 +52117,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -54637,7 +52163,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54652,36 +52178,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
update an existing virtual-data-center
-

PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ +
+
+
returns sriov-vfs
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: - CloudInfrastructure + Network
-

update an existing virtual-data-center

+

returns sriov-vfs

-
- -

application/json application/xml -

-
-
-

virtual-data-center object that needs to be created or updated.

-

-
- -
-
@@ -54696,10 +52205,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -54710,6 +52235,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + + query + string + + +
+ vf-vlan-filter + + query + string + + +
+ vf-mac-filter + + query + string + + +
+ vf-vlan-strip + + query + boolean + + +
+ neutron-network-id + + query + string + + +
@@ -54719,6 +52314,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -54726,7 +52344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54741,24 +52359,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing virtual-data-center
-

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+
returns sriov-vf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: - CloudInfrastructure + Network
-

delete an existing virtual-data-center

+

returns sriov-vf

-
- -

application/json application/xml -

-
@@ -54773,10 +52386,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + + +
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

path @@ -54789,12 +52402,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path string @@ -54812,6 +52441,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -54819,7 +52471,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54834,17 +52486,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+
create or update an existing sriov-vf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: - CloudInfrastructure + Network
-

see node definition for valid relationships

+

create or update an existing sriov-vf

@@ -54853,13 +52505,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -54878,10 +52530,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

path @@ -54908,7 +52592,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54923,23 +52607,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+
update an existing sriov-vf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: - CloudInfrastructure + Network
-

delete an existing relationship

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -54955,10 +52651,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vdc-id + vnf-id -

Unique ID of the vdc

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

path @@ -54985,71 +52713,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - - - - - -
-
-
returns generic-vnfs
-

GET /network/generic-vnfs

- Tags: - Network -
-
-
-

returns generic-vnfs

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55064,19 +52728,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns generic-vnf
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}

+
delete an existing sriov-vf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns generic-vnf

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
@@ -55107,40 +52776,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + pci-id -

Alternate name of VNF.

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-type + resource-version -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

resource-version for concurrency

query @@ -55148,132 +52819,332 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + + +
- service-id + vnf-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Unique id of VNF. This is unique across the graph.

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- heat-stack-id + vnf-id -

Heat stack id corresponding to this instance, managed by MSO

+

Unique id of VNF. This is unique across the graph.

querypath string +
- in-maint + interface-name +

Name given to the interface

querypath - boolean + string +
- is-closed-loop-disabled + pci-id +

PCI ID used to identify the sriov-vf

querypath - boolean + string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + + +
- model-invariant-id + vnf-id -

the ASDC model id for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name given to the interface

querypath string +
- widget-model-id + vlan-interface -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -55285,14 +53156,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query - string + integer @@ -55300,10 +53170,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + vpn-id -

Generic description of the type of NF

query @@ -55313,49 +53182,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - + - + - + @@ -55384,7 +53335,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -55397,7 +53348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55412,17 +53363,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing generic-vnf
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

+
create or update an existing vlan
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing generic-vnf

+

create or update an existing vlan

@@ -55431,13 +53382,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

@@ -55470,6 +53421,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- nf-function + vnf-id -

English description of Network function that the specific VNF deployment is providing

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name given to the interface

querypath string +
- nf-naming-code + vlan-interface -

string assigned to this model used for naming purposes

+

String that identifies the interface

querypath string +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -55486,7 +53469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55501,17 +53484,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing generic-vnf
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

+
update an existing vlan
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

update an existing generic-vnf

+

update an existing vlan

@@ -55520,13 +53503,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

generic-vnf object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -55559,6 +53542,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -55575,7 +53590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55590,17 +53605,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing generic-vnf
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

+
delete an existing vlan
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing generic-vnf

+

delete an existing vlan

@@ -55636,6 +53651,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
resource-version @@ -55668,7 +53715,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55683,17 +53730,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlements
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns entitlements

+

returns l3-interface-ipv4-address-list

@@ -55726,255 +53773,347 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + vlan-interface -

Alternate name of VNF.

+

String that identifies the interface

querypath string +
- vnf-type + l3-interface-ipv4-address -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + + +
- service-id + vnf-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Unique id of VNF. This is unique across the graph.

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
querypath string +
- widget-model-id + vlan-interface -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

String that identifies the interface

querypath string +
- widget-model-version + l3-interface-ipv4-address -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - + - + - + - + @@ -55986,29 +54125,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -56016,7 +54132,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56031,19 +54147,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlement
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns entitlement

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + vlan-interface -

role in the network that this model will be providing

+

String that identifies the interface

querypath string +
- nf-naming-code + l3-interface-ipv4-address -

string assigned to this model used for naming purposes

+

IP address

querypath string +
@@ -56074,10 +54195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56090,10 +54211,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

path @@ -56106,40 +54227,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 + l3-interface-ipv4-address -

Alternate name of VNF.

+

IP address

querypath string +
- vnf-type + resource-version -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

resource-version for concurrency

query @@ -56147,214 +54254,389 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- service-id + vnf-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Unique id of VNF. This is unique across the graph.

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
- prov-status + vlan-interface -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

String that identifies the interface

querypath string +
- heat-stack-id + l3-interface-ipv4-address -

Heat stack id corresponding to this instance, managed by MSO

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + + +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + vnf-id -

the ASDC model id for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name given to the interface

querypath string +
- widget-model-id + vlan-interface -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

String that identifies the interface

querypath string +
- widget-model-version + l3-interface-ipv4-address -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -56383,7 +54665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -56396,7 +54678,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56411,17 +54693,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing entitlement
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing entitlement

+

create or update an existing l3-interface-ipv6-address-list

@@ -56430,13 +54712,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -56471,10 +54753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + vlan-interface -

role in the network that this model will be providing

+

String that identifies the interface

querypath string +
- nf-naming-code + l3-interface-ipv6-address -

string assigned to this model used for naming purposes

+

IP address

querypath string +
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56487,10 +54769,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -56517,7 +54815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56532,17 +54830,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing entitlement
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

update an existing entitlement

+

update an existing l3-interface-ipv6-address-list

@@ -56551,13 +54849,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -56592,10 +54890,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56608,10 +54906,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -56638,7 +54952,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56653,17 +54967,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing entitlement
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing entitlement

+

delete an existing l3-interface-ipv6-address-list

@@ -56701,10 +55015,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56717,10 +55031,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -56763,7 +55093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56778,11 +55108,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -56797,7 +55127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -56838,10 +55168,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56854,10 +55184,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -56884,7 +55230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56899,11 +55245,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -56947,10 +55293,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name given to the interface

path @@ -56963,10 +55309,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + vlan-interface -

Unique ID of an entitlement resource.

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

path @@ -56993,7 +55355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57008,19 +55370,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
@@ -57051,218 +55430,222 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + + +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + vlan-interface -

the ASDC model id for this resource or service model.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- model-version-id + vnf-id -

the ASDC model version for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- widget-model-id + interface-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name given to the interface

querypath string +
- widget-model-version + vlan-interface -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

query @@ -57274,10 +55657,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + interface-id -

role in the network that this model will be providing

query @@ -57289,10 +55671,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + interface-role -

string assigned to this model used for naming purposes

query @@ -57328,7 +55709,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -57341,7 +55722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57356,17 +55737,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
returns l-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ +
+
+
returns lag-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns l-interface

+

returns lag-interface

@@ -57402,7 +55783,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

+

Name that identifies the link aggregate interface

path @@ -57413,304 +55794,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
@@ -57737,7 +55820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -57750,7 +55833,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57765,17 +55848,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
create or update an existing lag-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing lag-interface

@@ -57784,13 +55867,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

@@ -57828,7 +55911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

+

Name that identifies the link aggregate interface

path @@ -57855,7 +55938,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57870,17 +55953,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l-interface
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
update an existing lag-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

update an existing l-interface

+

update an existing lag-interface

@@ -57889,13 +55972,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

lag-interface object that needs to be updated.

@@ -57933,7 +56016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

+

Name that identifies the link aggregate interface

path @@ -57960,7 +56043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57975,17 +56058,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
delete an existing lag-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing l-interface

+

delete an existing lag-interface

@@ -58026,7 +56109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

+

Name that identifies the link aggregate interface

path @@ -58069,7 +56152,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58084,17 +56167,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns l-interfaces

@@ -58130,23 +56213,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

+

Name that identifies the link aggregate interface

path @@ -58159,248 +56226,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code + interface-name -

string assigned to this model used for naming purposes

query @@ -58415,7 +56243,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -58430,7 +56257,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen macaddr -

MAC address for the interface

query @@ -58445,52 +56271,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

query @@ -58526,7 +56306,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -58539,7 +56319,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58554,36 +56334,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
-
@@ -58617,112 +56380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - -
-

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

+

Name that identifies the link aggregate interface

path @@ -58749,22 +56407,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -58774,131 +56416,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- default +
+ 200 OK
-
+
-

Response codes found in response codes.

+

successful operation

- +
-
- -
-
- -
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
+
-
-

application/json application/xml -

- -
+ +
+
+ +
default @@ -58906,7 +56446,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58921,17 +56461,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -58940,13 +56480,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -58984,100 +56524,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - + +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

+

Name that identifies the link aggregate interface

path @@ -59104,15089 +56551,370 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv6-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

create or update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vfs
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

- Tags: - Network -
-
-
-

returns sriov-vfs

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vf
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

returns sriov-vf

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter - -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

-
query - string - - -
- vf-mac-filter - -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

-
query - string - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id - -

Neutron network id of the interface

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing sriov-vf
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

create or update an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing sriov-vf
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

update an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated.

-

-
-
-
-
- /sriov-vf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing sriov-vf
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

delete an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlans
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

- Tags: - Network -
-
-
-

returns vlans

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlan
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

returns vlan

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing vlan
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

create or update an existing vlan

- -
-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing vlan
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

update an existing vlan

- -
-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated.

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vlan
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

delete an existing vlan

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

create or update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv6-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

create or update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

- Tags: - Network -
-
-
-

returns lag-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

returns lag-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing lag-interface
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

create or update an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
-

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing lag-interface
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

update an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
-

lag-interface object that needs to be created or updated.

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing lag-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

delete an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

- Tags: - Network -
-
-
-

returns l-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

returns l-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l-interface
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

create or update an existing l-interface

- -
-
- -

application/json application/xml -

-
-
-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l-interface
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

update an existing l-interface

- -
-
- -

application/json application/xml -

-
-
-

l-interface object that needs to be created or updated.

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

delete an existing l-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

create or update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv6-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

create or update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vfs
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

- Tags: - Network -
-
-
-

returns sriov-vfs

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vf
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

returns sriov-vf

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter - -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

-
query - string - - -
- vf-mac-filter - -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

-
query - string - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id - -

Neutron network id of the interface

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing sriov-vf
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

create or update an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing sriov-vf
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

update an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated.

-

-
-
-
-
- /sriov-vf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing sriov-vf
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

delete an existing sriov-vf

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlans
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

- Tags: - Network -
-
-
-

returns vlans

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlan
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

returns vlan

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing vlan
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

create or update an existing vlan

- -
-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing vlan
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

update an existing vlan

- -
-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated.

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vlan
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

delete an existing vlan

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + + +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code + vnf-id -

string assigned to this model used for naming purposes

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name given to the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner + resource-version -

Inner VLAN tag

+

resource-version for concurrency

query - integer + string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -74228,7 +56956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74243,11 +56971,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
@@ -74262,7 +56990,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -74333,22 +57061,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vpn-id + vnf-id -

This indicates the customers VPN ID associated with this vlan

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the link aggregate interface

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -74381,7 +57093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74396,11 +57108,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
update an existing l3-interface-ipv4-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
@@ -74415,7 +57127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -74486,22 +57198,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -74534,7 +57230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74549,11 +57245,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
@@ -74627,22 +57323,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -74691,7 +57371,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74706,11 +57386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -74725,7 +57405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -74796,22 +57476,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -74844,7 +57508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74859,11 +57523,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -74937,22 +57601,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv4-address @@ -74985,7 +57633,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75000,11 +57648,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
@@ -75073,22 +57721,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
l3-interface-ipv6-address @@ -75105,250 +57737,434 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + + +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type + vnf-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- service-id + interface-name -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Name that identifies the link aggregate interface

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
- prov-status + l3-interface-ipv6-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - + - + - + + +
- heat-stack-id + vnf-id -

Heat stack id corresponding to this instance, managed by MSO

+

Unique id of VNF. This is unique across the graph.

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name that identifies the link aggregate interface

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name given to the interface

querypath string +
- widget-model-id + l3-interface-ipv6-address -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + + +
- widget-model-version + vnf-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-type + interface-name -

Generic description of the type of NF

+

Name that identifies the link aggregate interface

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + l3-interface-ipv6-address -

role in the network that this model will be providing

+

IP address

querypath string +
- nf-naming-code + resource-version -

string assigned to this model used for naming purposes

+

resource-version for concurrency

query @@ -75356,156 +58172,269 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + l3-interface-ipv6-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - + - - - - - - - - + - + @@ -75517,29 +58446,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -75547,7 +58453,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75562,17 +58468,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

@@ -75581,13 +58487,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -75652,38 +58558,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - -
- network-name + vnf-id -

Name of the network

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the link aggregate interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -75700,7 +58574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75715,35 +58589,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
@@ -75805,38 +58667,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -75853,7 +58683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75868,24 +58698,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns sriov-vfs
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -75948,42 +58773,65 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + @@ -76003,6 +58850,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -76010,7 +58880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76025,36 +58895,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns sriov-vf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

see node definition for valid relationships

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
- vlan-interface + pci-id -

String that identifies the interface

pathquery string -
- l3-interface-ipv6-address + vf-vlan-filter -

IP address

pathquery string -
- resource-version + vf-mac-filter + + query + string + + +
+ vf-vlan-strip + + query + boolean + + +
+ neutron-network-id -

resource-version for concurrency

query @@ -75991,7 +58839,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -76117,26 +58970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + +
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -76156,6 +58993,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -76163,7 +59023,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76178,23 +59038,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing sriov-vf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing relationship

+

create or update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -76258,26 +59130,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + +
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -76304,7 +59160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76319,17 +59175,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
update an existing sriov-vf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

see node definition for valid relationships

+

update an existing sriov-vf

@@ -76338,13 +59194,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

sriov-vf object that needs to be updated.

@@ -76411,10 +59267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -76441,7 +59297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76456,17 +59312,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
delete an existing sriov-vf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing relationship

+

delete an existing sriov-vf

@@ -76536,10 +59392,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -76550,6 +59406,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -76566,7 +59438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76581,11 +59453,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -76600,7 +59472,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -76655,6 +59527,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -76671,7 +59575,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76686,11 +59590,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -76748,6 +59652,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -76764,7 +59700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76779,17 +59715,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns licenses
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

+
returns vlans
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

returns licenses

+

returns vlans

@@ -76822,158 +59758,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name that identifies the link aggregate interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + vlan-interface -

the ASDC model version for this resource or service model.

query @@ -76985,14 +59804,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + vlan-id-inner -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query - string + integer @@ -77000,10 +59818,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vpn-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -77013,64 +59830,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -77099,7 +59999,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -77112,7 +60012,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77127,19 +60027,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns license
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
create or update an existing vlan
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

returns license

+

create or update an existing vlan

+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name that identifies the link aggregate interface

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name given to the interface

querypath string +
- nf-naming-code + vlan-interface -

string assigned to this model used for naming purposes

+

String that identifies the interface

querypath string +
@@ -77170,10 +60087,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -77186,10 +60103,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

path @@ -77202,173 +60119,288 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + vlan-interface -

Name of VNF.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- vnf-name2 + vnf-id -

Alternate name of VNF.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name that identifies the link aggregate interface

querypath string +
- service-id + interface-name -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Name given to the interface

querypath string +
- regional-resource-zone + vlan-interface -

Regional way of organizing pservers, source of truth should define values

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - + - + + +
- prov-status + vnf-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name that identifies the link aggregate interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + vlan-interface -

the ASDC model version for this resource or service model.

+

String that identifies the interface

querypath string +
- widget-model-id + resource-version -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

resource-version for concurrency

query @@ -77376,81 +60408,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + - + @@ -77479,7 +60573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -77492,7 +60586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77507,17 +60601,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing license
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing license

+

create or update an existing l3-interface-ipv4-address-list

@@ -77526,13 +60620,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -77567,10 +60661,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- widget-model-version + vnf-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-type + interface-name -

Generic description of the type of NF

+

Name that identifies the link aggregate interface

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + vlan-interface -

role in the network that this model will be providing

+

String that identifies the interface

querypath string +
- nf-naming-code + l3-interface-ipv4-address -

string assigned to this model used for naming purposes

+

IP address

querypath string +
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -77583,10 +60677,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -77613,7 +60739,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77628,17 +60754,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing license
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

update an existing license

+

update an existing l3-interface-ipv4-address-list

@@ -77647,13 +60773,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -77688,10 +60814,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -77704,10 +60830,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -77734,7 +60892,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77749,17 +60907,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing license
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing license

+

delete an existing l3-interface-ipv4-address-list

@@ -77797,10 +60955,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -77813,10 +60971,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -77859,7 +61049,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77874,11 +61064,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -77893,7 +61083,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -77934,10 +61124,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -77950,10 +61140,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -77980,7 +61202,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77995,11 +61217,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -78043,10 +61265,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

path @@ -78059,10 +61281,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

path @@ -78073,85 +61295,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - -
- vnf-id + vlan-interface -

Unique id of VNF. This is unique across the graph.

+

String that identifies the interface

path @@ -78162,73 +61311,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - + - + - + - + + +
- vnf-id + l3-interface-ipv4-address -

Unique id of VNF. This is unique across the graph.

+

IP address

path @@ -78255,7 +61343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78270,17 +61358,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vf-modules
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns vf-modules

+

returns l3-interface-ipv6-address-list

@@ -78313,255 +61401,395 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name that identifies the link aggregate interface

querypath string +
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name given to the interface

querypath string +
- service-id + vlan-interface -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

String that identifies the interface

querypath string +
- regional-resource-zone + l3-interface-ipv6-address -

Regional way of organizing pservers, source of truth should define values

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

create or update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - + - + - + + +
- prov-status + vnf-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name that identifies the link aggregate interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + vlan-interface -

the ASDC model version for this resource or service model.

+

String that identifies the interface

querypath string +
- widget-model-id + l3-interface-ipv6-address -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -78573,29 +61801,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -78603,7 +61808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78618,19 +61823,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vf-module
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns vf-module

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
- widget-model-version + vnf-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-type + interface-name -

Generic description of the type of NF

+

Name that identifies the link aggregate interface

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + vlan-interface -

role in the network that this model will be providing

+

String that identifies the interface

querypath string +
- nf-naming-code + l3-interface-ipv6-address -

string assigned to this model used for naming purposes

+

IP address

querypath string +
@@ -78661,10 +61871,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + +
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

path @@ -78677,55 +61887,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + vlan-interface -

Alternate name of VNF.

+

String that identifies the interface

querypath string +
- vnf-type + l3-interface-ipv6-address -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

IP address

querypath string +
- service-id + resource-version -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

resource-version for concurrency

query @@ -78733,304 +61946,563 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - - + - + + +
- regional-resource-zone + vnf-id -

Regional way of organizing pservers, source of truth should define values

+

Unique id of VNF. This is unique across the graph.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name that identifies the link aggregate interface

querypath string +
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + vlan-interface -

the ASDC model id for this resource or service model.

+

String that identifies the interface

querypath string +
- model-version-id + l3-interface-ipv6-address -

the ASDC model version for this resource or service model.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + + +
- widget-model-id + vnf-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- widget-model-version + interface-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Name that identifies the link aggregate interface

querypath string +
- nf-type + interface-name -

Generic description of the type of NF

+

Name given to the interface

querypath string +
- nf-function + vlan-interface -

English description of Network function that the specific VNF deployment is providing

+

String that identifies the interface

querypath string +
- nf-role + l3-interface-ipv6-address -

role in the network that this model will be providing

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- nf-naming-code + vnf-id -

string assigned to this model used for naming purposes

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vf-module-name + interface-name -

Name of vf-module

+

Name that identifies the link aggregate interface

querypath string +
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance.

+

Name given to the interface

querypath string +
- model-invariant-id + vlan-interface -

the ASDC model id for this resource or service model.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + @@ -79042,29 +62514,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -79072,7 +62521,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79087,17 +62536,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vf-module
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

create or update an existing vf-module

+

see node definition for valid relationships

@@ -79106,13 +62555,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

@@ -79147,10 +62596,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- model-version-id + vnf-id -

the ASDC model version for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- widget-model-id + interface-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name that identifies the link aggregate interface

querypath string +
- widget-model-version + interface-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Name given to the interface

querypath string +
- contrail-service-instance-fqdn + vlan-interface -

the Contrail unique ID for a service-instance

+

String that identifies the interface

querypath string +
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

path @@ -79177,7 +62626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79192,35 +62641,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vf-module
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

update an existing vf-module

+

delete an existing relationship

application/json application/xml

-
-
-

vf-module object that needs to be created or updated.

-

-
-
-
- -
-
@@ -79252,10 +62689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -91212,7 +74146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -91225,7 +74159,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91240,19 +74174,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

path @@ -79282,7 +62719,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79297,24 +62734,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vf-module
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
returns licenses
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

Tags: Network
-

delete an existing vf-module

+

returns licenses

-
- -

application/json application/xml -

-
@@ -79345,26 +62777,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -79384,6 +62812,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
default @@ -79391,7 +62842,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79406,36 +62857,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+
returns license
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

see node definition for valid relationships

+

returns license

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

-

-
-
-
- -
-
-
- vf-module-id + group-uuid -

Unique ID of vf-module.

pathquery string -
- resource-version + resource-uuid -

resource-version for concurrency

query @@ -79372,7 +62801,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -79466,10 +62900,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - -
- vf-module-id + group-uuid -

Unique ID of vf-module.

+

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

path @@ -79489,6 +62939,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
default @@ -79496,7 +62969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79511,23 +62984,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+
create or update an existing license
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing relationship

+

create or update an existing license

application/json application/xml

+
+
+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
@@ -79559,10 +63044,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + @@ -80908,7 +64689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -80921,7 +64702,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80936,17 +64717,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vig-server
-

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
returns instance-group
+

GET /network/instance-groups/instance-group/{id}

Tags: Network
-

returns vig-server

+

returns instance-group

@@ -80963,26 +64744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vf-module-id + group-uuid -

Unique ID of vf-module.

+

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

path @@ -79589,7 +63090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79604,83 +63105,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns instance-groups
-

GET /network/instance-groups

+
update an existing license
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

returns instance-groups

+

update an existing license

- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
+
+ +

application/json application/xml +

+
+
+

license object that needs to be updated.

+

- -
-
-
-
-
- - -
-
-
returns instance-group
-

GET /network/instance-groups/instance-group/{id}

- Tags: - Network -
-
-
-

returns instance-group

- -
+
+
+
+ /license +
+
+
+
@@ -79695,10 +63149,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -79763,29 +63204,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -79793,7 +63211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79808,35 +63226,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing instance-group
-

PUT /network/instance-groups/instance-group/{id}

+
delete an existing license
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

create or update an existing instance-group

+

delete an existing license

application/json application/xml

-
-
-

instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)

-

-
-
-
- -
-
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

path @@ -79711,47 +63165,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- description - -

Descriptive text to help identify the usage of this instance-group

-
query - string - - -
- type + group-uuid -

Only valid value today is lower case ha for high availability

+

Unique ID for the license group the resource belongs to, should be uuid.

querypath string +
- sub-type + resource-uuid -

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

+

Unique ID of a license resource.

querypath string +
@@ -79852,10 +63258,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

path @@ -79866,6 +63304,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -79882,7 +63336,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79897,17 +63351,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing instance-group
-

PATCH /network/instance-groups/instance-group/{id}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

update an existing instance-group

+

see node definition for valid relationships

@@ -79916,13 +63370,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

instance-group object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

@@ -79941,10 +63395,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+
path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

path @@ -79971,7 +63457,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79986,17 +63472,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing instance-group
-

DELETE /network/instance-groups/instance-group/{id}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

delete an existing instance-group

+

delete an existing relationship

@@ -80018,10 +63504,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

path @@ -80034,12 +63520,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + group-uuid -

resource-version for concurrency

+

Unique ID for the license group the resource belongs to, should be uuid.

querypath + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+
path string @@ -80064,7 +63566,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80079,11 +63581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -80098,7 +63600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

@@ -80123,10 +63625,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

path @@ -80153,7 +63655,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80168,11 +63670,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -80200,10 +63702,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

path @@ -80230,7 +63732,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80245,19 +63747,162 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ipsec-configurations
-

GET /network/ipsec-configurations

+
returns vf-modules
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

Tags: Network
-

returns ipsec-configurations

+

returns vf-modules

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + + query + string + + +
+ vf-module-name + + query + string + + +
+ heat-stack-id + + query + string + + +
+ model-invariant-id + + query + string + + +
+ model-version-id + + query + string + + +
+ widget-model-id + + query + string + + +
+ widget-model-version + + query + string + + +
+ contrail-service-instance-fqdn + + query + string + + +
+

application/json application/xml @@ -80281,7 +63926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

@@ -80294,7 +63939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80309,17 +63954,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ipsec-configuration
-

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+
returns vf-module
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

returns ipsec-configuration

+

returns vf-module

@@ -80336,10 +63981,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80376,7 +64037,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -80389,7 +64050,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80404,17 +64065,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing ipsec-configuration
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+
create or update an existing vf-module
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

create or update an existing ipsec-configuration

+

create or update an existing vf-module

@@ -80423,13 +64084,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

@@ -80448,10 +64109,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80478,7 +64155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80493,17 +64170,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing ipsec-configuration
-

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+
update an existing vf-module
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

update an existing ipsec-configuration

+

update an existing vf-module

@@ -80512,13 +64189,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ipsec-configuration object that needs to be created or updated.

+

vf-module object that needs to be updated.

@@ -80537,10 +64214,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80567,7 +64260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80582,17 +64275,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ipsec-configuration
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+
delete an existing vf-module
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

delete an existing ipsec-configuration

+

delete an existing vf-module

@@ -80614,10 +64307,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80660,7 +64369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80675,11 +64384,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
@@ -80694,7 +64403,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

@@ -80719,10 +64428,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80749,7 +64474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80764,11 +64489,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
@@ -80796,10 +64521,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

path @@ -80826,7 +64567,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80841,17 +64582,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vig-servers
-

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

+
returns instance-groups
+

GET /network/instance-groups

Tags: Network
-

returns vig-servers

+

returns instance-groups

@@ -80868,18 +64609,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + id -

UUID of this configuration

pathquery + string + + +
+ description + + query + string + + +
+ type + + query + string + + +
+ sub-type + + query string -
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81019,7 +64784,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -81032,7 +64797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81047,17 +64812,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vig-server
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
create or update an existing instance-group
+

PUT /network/instance-groups/instance-group/{id}

Tags: Network
-

create or update an existing vig-server

+

create or update an existing instance-group

@@ -81066,13 +64831,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)

@@ -81091,26 +64856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81137,7 +64886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81152,17 +64901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vig-server
-

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
update an existing instance-group
+

PATCH /network/instance-groups/instance-group/{id}

Tags: Network
-

update an existing vig-server

+

update an existing instance-group

@@ -81171,13 +64920,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vig-server object that needs to be created or updated.

+

instance-group object that needs to be updated.

@@ -81196,26 +64945,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81242,7 +64975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81257,17 +64990,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vig-server
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
delete an existing instance-group
+

DELETE /network/instance-groups/instance-group/{id}

Tags: Network
-

delete an existing vig-server

+

delete an existing instance-group

@@ -81289,26 +65022,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81351,7 +65068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81366,11 +65083,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+

PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

Tags: Network
@@ -81385,7 +65102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)

@@ -81410,26 +65127,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81456,7 +65157,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81471,11 +65172,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

Tags: Network
@@ -81503,26 +65204,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

-
path - string - - - -
- vig-address-type + id -

indicates whether the VIG is for AVPN or INTERNET

+

Instance Group ID, UUID assigned to this instance.

path @@ -81549,7 +65234,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81564,19 +65249,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-networks
-

GET /network/l3-networks

+
returns ipsec-configurations
+

GET /network/ipsec-configurations

Tags: Network
-

returns l3-networks

+

returns ipsec-configurations

+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + + query + string + + +
+

application/json application/xml @@ -81600,7 +65314,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

@@ -81613,7 +65327,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81628,17 +65342,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-network
-

GET /network/l3-networks/l3-network/{network-id}

+
returns ipsec-configuration
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

returns l3-network

+

returns ipsec-configuration

@@ -81655,10 +65369,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -81669,141 +65383,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
@@ -81830,7 +65409,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -81843,7 +65422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81858,17 +65437,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-network
-

PUT /network/l3-networks/l3-network/{network-id}

+
create or update an existing ipsec-configuration
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

create or update an existing l3-network

+

create or update an existing ipsec-configuration

@@ -81877,13 +65456,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)

+

ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

@@ -81902,10 +65481,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -81932,7 +65511,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81947,17 +65526,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-network
-

PATCH /network/l3-networks/l3-network/{network-id}

+
update an existing ipsec-configuration
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

update an existing l3-network

+

update an existing ipsec-configuration

@@ -81966,13 +65545,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-network object that needs to be created or updated.

+

ipsec-configuration object that needs to be updated.

@@ -81991,10 +65570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82021,7 +65600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82036,17 +65615,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-network
-

DELETE /network/l3-networks/l3-network/{network-id}

+
delete an existing ipsec-configuration
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

delete an existing l3-network

+

delete an existing ipsec-configuration

@@ -82068,10 +65647,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82114,7 +65693,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82129,19 +65708,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-assignments
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

+
see node definition for valid relationships
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network
-

returns ctag-assignments

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+ +
+
+
@@ -82156,10 +65752,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82170,141 +65766,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
@@ -82314,29 +65775,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -82344,7 +65782,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82359,19 +65797,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns ctag-assignment
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
delete an existing relationship
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network
-

returns ctag-assignment

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -82386,10 +65829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82400,157 +65843,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

id.

-
path - integer - - - -
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
@@ -82560,29 +65852,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -82590,7 +65859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82605,36 +65874,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ctag-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
returns vig-servers
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

Tags: Network
-

create or update an existing ctag-assignment

+

returns vig-servers

-
- -

application/json application/xml -

-
-
-

ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

-

-
-
-
-
-
@@ -82649,10 +65901,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -82688,6 +65938,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -82695,7 +65968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82710,36 +65983,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing ctag-assignment
-

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
returns vig-server
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

update an existing ctag-assignment

+

returns vig-server

-
- -

application/json application/xml -

-
-
-

ctag-assignment object that needs to be created or updated.

-

-
-
-
-
-
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82665,18 +65917,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vig-address-type -

id.

pathquery - integer + string -
@@ -82754,10 +66010,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82770,14 +66026,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vig-address-type -

id.

+

indicates whether the VIG is for AVPN or INTERNET

path - integer + string @@ -82793,6 +66049,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -82800,7 +66079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82815,23 +66094,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ctag-assignment
-

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
create or update an existing vig-server
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

delete an existing ctag-assignment

+

create or update an existing vig-server

application/json application/xml

+
+
+

vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+ +
+
@@ -82847,30 +66138,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - + @@ -83334,7 +66655,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-id - -

Network ID, should be uuid. Unique across A&AI.

-
path - string - - - -
- vlan-id-inner + ipsec-configuration-id -

id.

+

UUID of this configuration

path - integer + string @@ -82879,12 +66154,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vig-address-type -

resource-version for concurrency

+

indicates whether the VIG is for AVPN or INTERNET

querypath string @@ -82909,7 +66184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82924,17 +66199,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
update an existing vig-server
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

see node definition for valid relationships

+

update an existing vig-server

@@ -82943,13 +66218,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

vig-server object that needs to be updated.

@@ -82968,10 +66243,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -82984,14 +66259,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vig-address-type -

id.

+

indicates whether the VIG is for AVPN or INTERNET

path - integer + string @@ -83014,7 +66289,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83029,17 +66304,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
delete an existing vig-server
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

delete an existing relationship

+

delete an existing vig-server

@@ -83061,10 +66336,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

path @@ -83077,14 +66352,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vig-address-type -

id.

+

indicates whether the VIG is for AVPN or INTERNET

path - integer + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string @@ -83107,7 +66398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83122,11 +66413,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network
@@ -83141,7 +66432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

@@ -83166,10 +66457,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

path @@ -83196,7 +66503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83211,11 +66518,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network
@@ -83243,10 +66550,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + ipsec-configuration-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID of this configuration

+
path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

path @@ -83273,7 +66596,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83288,17 +66611,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns segmentation-assignments
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

+
returns l3-networks
+

GET /network/l3-networks

Tags: Network
-

returns segmentation-assignments

+

returns l3-networks

@@ -83318,15 +66641,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-id
-

Network ID, should be uuid. Unique across A&AI.

pathquery string -
-

Name of the network, governed by some naming convention..

query @@ -83349,7 +66669,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-role -

Role the network plans - who defines these values?

query @@ -83364,7 +66683,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

query @@ -83379,7 +66697,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

query @@ -83394,7 +66711,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen contrail-network-fqdn -

Contrail FQDN for the network

query @@ -83409,7 +66725,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id -

the ASDC model id for this resource or service model.

query @@ -83424,7 +66739,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -83439,7 +66753,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -83454,7 +66767,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -83490,7 +66802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -83503,7 +66815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83518,17 +66830,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns segmentation-assignment
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
returns l3-network
+

GET /network/l3-networks/l3-network/{network-id}

Tags: Network
-

returns segmentation-assignment

+

returns l3-network

@@ -83559,157 +66871,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
@@ -83736,7 +66897,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -83749,7 +66910,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83764,17 +66925,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing segmentation-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
create or update an existing l3-network
+

PUT /network/l3-networks/l3-network/{network-id}

Tags: Network
-

create or update an existing segmentation-assignment

+

create or update an existing l3-network

@@ -83783,13 +66944,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)

@@ -83822,22 +66983,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
@@ -83854,7 +66999,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83869,17 +67014,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing segmentation-assignment
-

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
update an existing l3-network
+

PATCH /network/l3-networks/l3-network/{network-id}

Tags: Network
-

update an existing segmentation-assignment

+

update an existing l3-network

@@ -83888,13 +67033,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

segmentation-assignment object that needs to be created or updated.

+

l3-network object that needs to be updated.

@@ -83927,22 +67072,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
@@ -83959,7 +67088,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83974,17 +67103,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing segmentation-assignment
-

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
delete an existing l3-network
+

DELETE /network/l3-networks/l3-network/{network-id}

Tags: Network
-

delete an existing segmentation-assignment

+

delete an existing l3-network

@@ -84020,22 +67149,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
resource-version @@ -84068,7 +67181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84083,36 +67196,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
returns ctag-assignments
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

Tags: Network
-

see node definition for valid relationships

+

returns ctag-assignments

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

-

-
-
-
- -
-
-
@@ -84143,18 +67239,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -84166,6 +67260,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -84173,7 +67290,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84188,24 +67305,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
returns ctag-assignment
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

delete an existing relationship

+

returns ctag-assignment

-
- -

application/json application/xml -

-
- segmentation-id + vlan-id-inner -

Route Table Reference id, UUID assigned to this instance.

pathquery - string + integer -
@@ -84236,14 +67348,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- segmentation-id + vlan-id-inner -

Route Table Reference id, UUID assigned to this instance.

+

id.

path - string + integer @@ -84259,6 +67371,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -84266,7 +67401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84281,19 +67416,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnets
-

GET /network/l3-networks/l3-network/{network-id}/subnets

+
create or update an existing ctag-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

returns subnets

+

create or update an existing ctag-assignment

+
+ +

application/json application/xml +

+
+
+

ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

+
+
+
+
+
@@ -84324,137 +67476,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -84466,29 +67499,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnets -
-
-
- -
default @@ -84496,7 +67506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84511,19 +67521,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnet
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
update an existing ctag-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

returns subnet

+

update an existing ctag-assignment

+
+ +

application/json application/xml +

+
+
+

ctag-assignment object that needs to be updated.

+

+
+
+
+
+
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

id.

querypath - string + integer +
@@ -84554,170 +67581,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- subnet-id + vlan-id-inner -

Subnet ID, should be UUID.

+

id.

path - string + integer
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- subnet-name - -

Name associated with the subnet.

-
query - string - - -
@@ -84727,29 +67604,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnet -
-
-
- -
default @@ -84757,7 +67611,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84772,35 +67626,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing subnet
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
delete an existing ctag-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

create or update an existing subnet

+

delete an existing ctag-assignment

application/json application/xml

-
-
-

subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

-

-
-
-
-
- /subnet -
-
-
@@ -84832,12 +67674,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - - + +
- subnet-id + vlan-id-inner -

Subnet ID, should be UUID.

+

id.

path + integer + + + +
+ resource-version + +

resource-version for concurrency

+
query string @@ -84862,7 +67720,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84877,17 +67735,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing subnet
-

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network
-

update an existing subnet

+

see node definition for valid relationships

@@ -84896,13 +67754,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

subnet object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

@@ -84937,14 +67795,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + vlan-id-inner -

Subnet ID, should be UUID.

+

id.

path - string + integer @@ -84967,7 +67825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84982,17 +67840,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing subnet
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network
-

delete an existing subnet

+

delete an existing relationship

@@ -85030,30 +67888,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + vlan-id-inner -

Subnet ID, should be UUID.

+

id.

path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string + integer @@ -85076,7 +67918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85091,11 +67933,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Tags: Network
@@ -85110,7 +67952,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)

@@ -85149,12 +67991,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -86136,7 +69042,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -86149,7 +69055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86164,17 +69070,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- subnet-id + network-id -

Subnet ID, should be UUID.

+

Network ID, should be uuid. Unique across A&AI.

path @@ -85181,7 +68084,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85196,24 +68099,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+
returns segmentation-assignments
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

Tags: Network
-

delete an existing relationship

+

returns segmentation-assignments

-
- -

application/json application/xml -

-
@@ -85244,65 +68142,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- subnet-id + segmentation-id -

Subnet ID, should be UUID.

pathquery string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85353,17 +68208,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85420,7 +68291,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -85433,7 +68304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85448,17 +68319,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85522,7 +68409,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85537,17 +68424,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85611,7 +68514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85626,17 +68529,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85704,7 +68623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85719,11 +68638,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85793,7 +68728,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85808,11 +68743,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

Alphabetical concatenation of lag-interface names

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

path @@ -85870,7 +68821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85885,19 +68836,78 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85949,17 +68959,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

path @@ -85992,122 +69002,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- link-id - -

UUID of the logical-link, SDNC generates this.

-
query - string - - -
- circuit-id - -

Circuit id

-
query - string - - -
- purpose + subnet-id -

Reason for this entity, role it is playing

+

Subnet ID, should be UUID.

querypath string +
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

path @@ -86238,7 +69160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86253,17 +69175,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

path @@ -86327,7 +69265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86342,17 +69280,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

path @@ -86420,7 +69374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86435,11 +69389,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

path @@ -86509,7 +69479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86524,11 +69494,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + network-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

path @@ -86586,7 +69572,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86601,19 +69587,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86665,17 +69680,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -86732,7 +69747,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -86745,7 +69760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86760,17 +69775,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -86834,7 +69849,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86849,17 +69864,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -86923,7 +69938,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86938,17 +69953,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -87016,7 +70031,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87031,11 +70046,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -87105,7 +70120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87120,11 +70135,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- multicast-configuration-id + link-name -

Unique id of multicast configuration.

+

Alphabetical concatenation of lag-interface names

path @@ -87182,7 +70197,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87197,19 +70212,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87261,17 +70417,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87302,21 +70458,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-fqdn - -

Contrail FQDN for the policy

-
query - string - - -
@@ -87343,7 +70484,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -87356,7 +70497,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87371,17 +70512,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87445,7 +70586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87460,17 +70601,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87534,7 +70675,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87549,17 +70690,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87627,7 +70768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87642,11 +70783,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87716,7 +70857,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87731,11 +70872,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
- network-policy-id + link-name -

UUID representing unique key to this instance

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

path @@ -87793,7 +70934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87808,19 +70949,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns newvces
-

GET /network/newvces

+
returns multicast-configurations
+

GET /network/multicast-configurations

Tags: Network
-

returns newvces

+

returns multicast-configurations

+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + + query + string + + +
+

application/json application/xml @@ -87844,7 +71014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

@@ -87857,7 +71027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87872,17 +71042,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns newvce
-

GET /network/newvces/newvce/{vnf-id2}

+
returns multicast-configuration
+

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

returns newvce

+

returns multicast-configuration

@@ -87899,10 +71069,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + multicast-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique id of multicast configuration.

path @@ -87913,81 +71083,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
@@ -88014,7 +71109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -88027,7 +71122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88042,17 +71137,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing newvce
-

PUT /network/newvces/newvce/{vnf-id2}

+
create or update an existing multicast-configuration
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

create or update an existing newvce

+

create or update an existing multicast-configuration

@@ -88061,13 +71156,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)

+

multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)

@@ -88086,10 +71181,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + multicast-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique id of multicast configuration.

path @@ -88116,7 +71211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88131,17 +71226,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing newvce
-

PATCH /network/newvces/newvce/{vnf-id2}

+
update an existing multicast-configuration
+

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

update an existing newvce

+

update an existing multicast-configuration

@@ -88150,13 +71245,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

newvce object that needs to be created or updated.

+

multicast-configuration object that needs to be updated.

@@ -88175,10 +71270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + multicast-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique id of multicast configuration.

path @@ -88205,7 +71300,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88220,17 +71315,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing newvce
-

DELETE /network/newvces/newvce/{vnf-id2}

+
delete an existing multicast-configuration
+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

delete an existing newvce

+

delete an existing multicast-configuration

@@ -88252,10 +71347,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + multicast-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique id of multicast configuration.

path @@ -88298,7 +71393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88313,19 +71408,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

+
see node definition for valid relationships
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+
+
+ +
+
+
@@ -88340,10 +71452,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 + multicast-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique id of multicast configuration.

path @@ -88354,81 +71466,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
@@ -88438,29 +71475,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -88468,7 +71482,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88483,19 +71497,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
delete an existing relationship
+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network
-

returns l-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -88510,26 +71529,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

-
path - string - - - -
- interface-name + multicast-configuration-id -

Name given to the interface

+

Unique id of multicast configuration.

path @@ -88540,87 +71543,67 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policies
+

GET /network/network-policies

+ Tags: + Network +
+
+
+

returns network-policies

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id + network-policy-id -

ID of interface

query @@ -88632,10 +71615,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + network-policy-fqdn -

MAC address for the interface

query @@ -88645,19 +71627,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policy
+

GET /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

returns network-policy

+ +
+
+ + + + + + + + + + + - + @@ -88686,7 +71748,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -88699,7 +71761,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88714,17 +71776,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
create or update an existing network-policy
+

PUT /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing network-policy

@@ -88733,13 +71795,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)

@@ -88758,26 +71820,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - + +
- network-name + network-policy-id -

Name of the network

+

UUID representing unique key to this instance

querypath string +
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

-
path - string - - - -
- interface-name + network-policy-id -

Name given to the interface

+

UUID representing unique key to this instance

path @@ -88804,7 +71850,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88819,17 +71865,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l-interface
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
update an existing network-policy
+

PATCH /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

update an existing l-interface

+

update an existing network-policy

@@ -88838,13 +71884,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

network-policy object that needs to be updated.

@@ -88863,26 +71909,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

-
path - string - - - -
- interface-name + network-policy-id -

Name given to the interface

+

UUID representing unique key to this instance

path @@ -88909,7 +71939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88924,17 +71954,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
delete an existing network-policy
+

DELETE /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

delete an existing l-interface

+

delete an existing network-policy

@@ -88956,26 +71986,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

-
path - string - - - -
- interface-name + network-policy-id -

Name given to the interface

+

UUID representing unique key to this instance

path @@ -89018,7 +72032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89033,19 +72047,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+ +
+
+
@@ -89060,10 +72091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id2 + network-policy-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

UUID representing unique key to this instance

path @@ -89074,12 +72105,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + +
- interface-name + network-policy-id -

Name given to the interface

+

UUID representing unique key to this instance

path @@ -89090,20 +72182,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvces
+

GET /network/newvces

+ Tags: + Network +
+
+
+

returns newvces

+ +
+
+ + + + + + + + + + + - + @@ -89111,7 +72257,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- l3-interface-ipv4-address + vnf-id2 -

IP address

pathquery string -
-

Name of VNF.

query @@ -89126,7 +72271,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name2 -

Alternate name of VNF.

query @@ -89141,7 +72285,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-type -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

query @@ -89156,7 +72299,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -89171,82 +72313,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

query @@ -89256,19 +72322,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /newvces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvce
+

GET /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

returns newvce

+ +
+
+ + + + + + + + + + + - + @@ -89297,7 +72443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -89310,7 +72456,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89325,17 +72471,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing newvce
+

PUT /network/newvces/newvce/{vnf-id2}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing newvce

@@ -89344,13 +72490,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)

@@ -89383,38 +72529,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - -
- neutron-subnet-id + vnf-id2 -

Neutron id of subnet that address belongs to

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -89431,7 +72545,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89446,17 +72560,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing newvce
+

PATCH /network/newvces/newvce/{vnf-id2}

Tags: Network
-

update an existing l3-interface-ipv4-address-list

+

update an existing newvce

@@ -89465,13 +72579,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

newvce object that needs to be updated.

@@ -89504,12 +72618,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing newvce
+

DELETE /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

delete an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + + + + + + + +
- interface-name + vnf-id2 -

Name given to the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

path @@ -89522,12 +72697,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -89552,7 +72727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89567,24 +72742,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -89618,39 +72788,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + + + + + + + @@ -89670,6 +72848,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -89677,7 +72878,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89692,36 +72893,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l-interface
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
-

Name given to the interface

pathquery string -
- l3-interface-ipv4-address + interface-id -

IP address

pathquery string -
- resource-version + macaddr + + query + string + + +
+ network-name -

resource-version for concurrency

query @@ -89658,7 +72837,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -89766,22 +72950,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -89791,6 +72959,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -89798,7 +72989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89813,23 +73004,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l-interface
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

create or update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

+
+
+
+ +
+
@@ -89875,22 +73078,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -89907,7 +73094,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89922,19 +73109,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l-interface
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

update an existing l-interface

+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be updated.

+

+
+
+
+ +
+
+
@@ -89979,187 +73183,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -90169,29 +73192,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -90199,7 +73199,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90214,35 +73214,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l-interface
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

delete an existing l-interface

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
- -
@@ -90290,12 +73278,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -90320,7 +73308,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90335,36 +73323,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-interface-ipv4-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
@@ -90411,7 +73382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -90434,6 +73405,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -90441,7 +73435,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90456,23 +73450,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -90520,7 +73526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -90534,22 +73540,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -90566,7 +73556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90581,17 +73571,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -90600,13 +73590,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -90657,7 +73647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -90687,7 +73677,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90702,17 +73692,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -90766,7 +73756,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -90780,6 +73770,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -90796,7 +73802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90811,11 +73817,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -90830,7 +73836,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -90885,6 +73891,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -90901,7 +73923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90916,11 +73938,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -90978,6 +74000,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -90994,7 +74032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91009,17 +74047,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vfs

+

returns l3-interface-ipv6-address-list

@@ -91068,122 +74106,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -91299,10 +74250,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -91313,184 +74264,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - + @@ -91502,29 +74394,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -91532,7 +74401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91547,35 +74416,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing sriov-vf

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter + vnf-id2 -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- vf-mac-filter + interface-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Name given to the interface

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
@@ -91623,10 +74480,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -91637,6 +74494,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -91653,7 +74526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91668,17 +74541,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

update an existing sriov-vf

+

see node definition for valid relationships

@@ -91687,13 +74560,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -91744,10 +74617,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -91774,7 +74647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91789,17 +74662,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -91853,10 +74726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -91867,22 +74740,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -91899,7 +74756,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91914,11 +74771,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -91933,7 +74790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

@@ -91988,22 +74845,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -92020,7 +74861,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92035,11 +74876,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -92097,22 +74938,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -92129,7 +74954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92144,17 +74969,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+
returns sriov-vfs
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

returns vlans

+

returns sriov-vfs

@@ -92203,55 +75028,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status + pci-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -92263,10 +75042,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vf-vlan-filter -

Heat stack id corresponding to this instance, managed by MSO

query @@ -92278,10 +75056,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-mac-filter -

ID of interface

query @@ -92293,14 +75070,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -92308,10 +75084,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-network-id -

Name of the network

query @@ -92347,7 +75122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -92360,7 +75135,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92375,17 +75150,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns sriov-vf
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns vlan

+

returns sriov-vf

@@ -92434,10 +75209,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -92448,156 +75223,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -92624,7 +75249,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -92637,7 +75262,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92652,17 +75277,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing sriov-vf
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

create or update an existing vlan

+

create or update an existing sriov-vf

@@ -92671,13 +75296,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -92728,10 +75353,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -92758,7 +75383,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92773,17 +75398,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing sriov-vf
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

update an existing vlan

+

update an existing sriov-vf

@@ -92792,13 +75417,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -92849,10 +75474,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -92879,7 +75504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92894,17 +75519,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing sriov-vf
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing vlan

+

delete an existing sriov-vf

@@ -92958,10 +75583,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -93004,7 +75629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93019,19 +75644,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
@@ -93078,10 +75720,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -93092,12 +75734,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + + +
- l3-interface-ipv4-address + vnf-id2 -

IP address

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

path @@ -93110,115 +75813,129 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name given to the interface

querypath string +
- heat-stack-id + pci-id -

Heat stack id corresponding to this instance, managed by MSO

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + + +
- interface-id + vnf-id2 -

ID of interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + vlan-interface -

Name of the network

query @@ -93233,7 +75950,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vlan-id-inner -

Inner VLAN tag

query @@ -93248,7 +75964,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vpn-id -

This indicates the customers VPN ID associated with this vlan

query @@ -93258,49 +75973,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - + - + - + @@ -93329,7 +76126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -93342,7 +76139,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93357,17 +76154,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing vlan
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing vlan

@@ -93376,13 +76173,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

@@ -93447,22 +76244,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- vlan-id-inner + vnf-id2 -

Inner VLAN tag

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + vlan-interface -

Neutron id of subnet that address belongs to

+

String that identifies the interface

querypath string +
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -93479,7 +76260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93494,17 +76275,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing vlan
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

update an existing l3-interface-ipv4-address-list

+

update an existing vlan

@@ -93513,13 +76294,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -93584,22 +76365,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -93616,7 +76381,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93631,17 +76396,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing vlan
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing vlan

@@ -93709,22 +76474,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
resource-version @@ -93757,7 +76506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93772,36 +76521,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l3-interface-ipv4-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
@@ -93887,6 +76619,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -93894,7 +76649,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93909,23 +76664,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -94019,7 +76786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94034,19 +76801,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
+
@@ -94109,7 +76893,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -94123,201 +76907,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -94327,29 +76916,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -94357,7 +76923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94372,35 +76938,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
- -
@@ -94464,12 +77018,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -94494,7 +77064,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94509,17 +77079,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

@@ -94528,13 +77098,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -94601,7 +77171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -94631,7 +77201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94646,17 +77216,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing relationship

@@ -94726,7 +77296,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -94740,22 +77310,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -94772,7 +77326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94787,36 +77341,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
@@ -94902,6 +77439,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -94909,7 +77469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94924,23 +77484,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -95034,7 +77606,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95049,17 +77621,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -95068,13 +77640,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -95139,6 +77711,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -95155,7 +77743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95170,17 +77758,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -95248,6 +77836,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -95264,7 +77884,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95279,11 +77899,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -95298,7 +77918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -95337,6 +77957,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -95353,7 +78021,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95368,11 +78036,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -95414,132 +78082,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - - - - - - - -
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97580,17 +79487,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l-interface
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing pnf
+

PATCH /network/pnfs/pnf/{pnf-name}

Tags: Network
-

update an existing l-interface

+

update an existing pnf

@@ -97599,13 +79506,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

pnf object that needs to be updated.

@@ -97638,38 +79545,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
@@ -97686,7 +79561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97701,17 +79576,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
delete an existing pnf
+

DELETE /network/pnfs/pnf/{pnf-name}

Tags: Network
-

delete an existing l-interface

+

delete an existing pnf

@@ -97747,38 +79622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
resource-version @@ -97811,7 +79654,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97826,17 +79669,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns lag-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns lag-interfaces

@@ -97872,55 +79715,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -97935,7 +79729,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -97950,97 +79743,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-role -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

query @@ -98076,7 +79778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -98089,7 +79791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98104,36 +79806,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns lag-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns lag-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
-
@@ -98178,38 +79863,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -98219,143 +79872,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- default +
+ 200 OK
-
+
-

Response codes found in response codes.

+

successful operation

- +
-
- -
-
- -
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pnf-name - -

unique name of Physical Network Function.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
+
-
-

application/json application/xml -

- -
+ +
+
+ +
default @@ -98363,7 +79902,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98378,23 +79917,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing lag-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
@@ -98440,54 +79991,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -98504,7 +80007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98519,17 +80022,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing lag-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -98538,13 +80041,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

lag-interface object that needs to be updated.

@@ -98593,38 +80096,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -98641,7 +80112,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98656,17 +80127,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing lag-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing lag-interface

@@ -98720,28 +80191,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -98766,7 +80221,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98781,17 +80236,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns l-interfaces

@@ -98843,69 +80298,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -98920,7 +80312,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -98935,7 +80326,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen macaddr -

MAC address for the interface

query @@ -98950,7 +80340,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

query @@ -98960,49 +80349,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + - + - + - + @@ -99031,7 +80502,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -99044,7 +80515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99059,17 +80530,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l-interface

@@ -99078,13 +80549,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -99149,22 +80620,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- vlan-id-inner + pnf-name -

Inner VLAN tag

+

unique name of Physical Network Function.

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name that identifies the link aggregate interface

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name given to the interface

querypath string +
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -99181,7 +80636,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99196,17 +80651,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

update an existing l-interface

@@ -99215,13 +80670,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -99286,22 +80741,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -99318,7 +80757,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99333,17 +80772,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing l-interface

@@ -99413,10 +80852,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + - + + + + + + + + + + + + + + + - - - - - - -
+ pnf-name + +

unique name of Physical Network Function.

path @@ -99429,12 +80940,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path string @@ -99452,6 +80995,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -99459,7 +81025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99474,17 +81040,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv4-address-list

@@ -99493,13 +81059,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -99566,7 +81132,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -99596,7 +81162,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99611,23 +81177,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
@@ -99691,7 +81269,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -99721,7 +81299,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99736,35 +81314,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
@@ -99826,6 +81392,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -99842,7 +81440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99857,23 +81455,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
@@ -99935,6 +81545,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -99951,7 +81577,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99966,19 +81592,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns sriov-vfs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -100041,92 +81672,138 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- interface-id + l3-interface-ipv4-address -

ID of interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -100155,7 +81832,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -100168,7 +81845,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100183,19 +81860,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
- interface-role + pnf-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

unique name of Physical Network Function.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -100258,10 +81952,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -100272,154 +81966,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -100431,29 +82112,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -100461,7 +82119,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100476,35 +82134,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing sriov-vf

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + pnf-name -

Name of the network

+

unique name of Physical Network Function.

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name that identifies the link aggregate interface

querypath string +
- vf-mac-filter + interface-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Name given to the interface

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
@@ -100568,10 +82214,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -100582,6 +82228,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -100598,7 +82260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100613,17 +82275,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

update an existing sriov-vf

+

see node definition for valid relationships

@@ -100632,13 +82294,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -100705,10 +82367,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -100735,7 +82397,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100750,17 +82412,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -100830,10 +82492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -100844,22 +82506,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -100876,7 +82522,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100891,11 +82537,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -100910,7 +82556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -100981,22 +82627,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -101013,7 +82643,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101028,11 +82658,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -101106,22 +82736,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -101138,7 +82752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101153,17 +82767,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

returns vlans

+

returns sriov-vfs

@@ -101228,25 +82842,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- interface-id + pci-id -

ID of interface

query @@ -101258,10 +82856,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + vf-vlan-filter -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -101273,10 +82870,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-mac-filter -

ID of interface

query @@ -101288,14 +82884,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -101303,10 +82898,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-network-id -

Name of the network

query @@ -101342,7 +82936,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -101355,7 +82949,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101370,17 +82964,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns sriov-vf
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns vlan

+

returns sriov-vf

@@ -101445,10 +83039,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -101459,126 +83053,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -101605,7 +83079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -101618,7 +83092,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101633,17 +83107,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing sriov-vf
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

create or update an existing vlan

+

create or update an existing sriov-vf

@@ -101652,13 +83126,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -101725,10 +83199,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -101755,7 +83229,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101770,17 +83244,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing vlan
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing sriov-vf
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

update an existing vlan

+

update an existing sriov-vf

@@ -101789,13 +83263,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -101862,10 +83336,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -101892,7 +83366,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -101907,17 +83381,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing sriov-vf
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing vlan

+

delete an existing sriov-vf

@@ -101987,10 +83461,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -102033,7 +83507,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -102048,19 +83522,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
@@ -102123,10 +83614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -102137,12 +83628,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- l3-interface-ipv4-address + pnf-name -

IP address

+

unique name of Physical Network Function.

path @@ -102155,85 +83707,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + pci-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + + + + + + + + + +
- interface-id + pnf-name -

ID of interface

+

unique name of Physical Network Function.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
- network-name + interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface -

Name of the network

query @@ -102248,7 +83876,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vlan-id-inner -

Inner VLAN tag

query @@ -102263,7 +83890,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vpn-id -

This indicates the customers VPN ID associated with this vlan

query @@ -102273,49 +83899,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + - + - + - + @@ -102344,7 +84068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -102357,7 +84081,144 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
create or update an existing vlan
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the link aggregate interface

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + vlan-interface -

Neutron id of subnet that address belongs to

+

String that identifies the interface

querypath string +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

@@ -102372,17 +84233,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing vlan

@@ -102391,13 +84252,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

vlan object that needs to be updated.

@@ -102478,12 +84339,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+
path + string + + + +
- l3-interface-ipv4-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

path @@ -102494,6 +84448,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -102510,7 +84496,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -102526,35 +84512,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

update an existing l3-interface-ipv4-address-list

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
@@ -102656,6 +84625,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -102663,7 +84655,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -102679,22 +84671,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -102788,22 +84792,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -102820,7 +84808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -102835,17 +84823,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -102854,13 +84842,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -102973,7 +84961,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -102988,17 +84976,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -103098,6 +85086,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + +
@@ -103114,7 +85118,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -103129,19 +85133,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -103220,7 +85241,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -103234,169 +85255,281 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + + +
- inv-status + pnf-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

unique name of Physical Network Function.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name given to the interface

querypath string +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - - - - - - - - + - + - + - + @@ -103438,7 +85571,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -103591,7 +85724,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -103625,7 +85758,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -103744,7 +85877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -103901,7 +86034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104054,7 +86187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104195,7 +86328,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104332,7 +86465,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104457,7 +86590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104562,7 +86695,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104655,7 +86788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104713,10 +86846,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - - - - - - - - - - - - - -
- network-name + pnf-name -

Name of the network

+

unique name of Physical Network Function.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the link aggregate interface

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- inv-status + interface-name + + query + string + + +
+ prov-status -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -104765,7 +86911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -104837,36 +86983,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
@@ -104906,7 +87022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105011,7 +87127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105045,7 +87161,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated.

+

p-interface object that needs to be updated.

@@ -105116,7 +87232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105225,7 +87341,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105299,10 +87415,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -105314,10 +87429,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + interface-id + + + + query + + string + + + + + + + + macaddr + + + + query + + string + + + + + + + + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -105366,7 +87508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105454,81 +87596,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - @@ -105568,7 +87635,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105689,7 +87756,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105723,7 +87790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -105810,7 +87877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -105935,7 +88002,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -106039,126 +88106,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -106198,7 +88145,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -106335,285 +88282,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - -
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pnf-name - -

unique name of Physical Network Function.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pnf-name - -

unique name of Physical Network Function.

-
path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -106628,17 +88297,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -106647,13 +88316,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -106750,7 +88419,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -106765,17 +88434,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -106859,6 +88528,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + +
@@ -106875,7 +88560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -106890,19 +88575,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -106965,7 +88667,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -106979,124 +88681,249 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + + +
- inv-status + pnf-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

unique name of Physical Network Function.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name that identifies the physical interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -107138,7 +88965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107275,7 +89102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107309,7 +89136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -107412,7 +89239,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107553,7 +89380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107690,7 +89517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107815,7 +89642,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -107936,7 +89763,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108045,7 +89872,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108135,10 +89962,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-name + pnf-name -

Name of the network

+

unique name of Physical Network Function.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the physical interface

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- inv-status + pci-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -108150,10 +89976,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vf-vlan-filter -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -108165,10 +89990,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-mac-filter -

ID of interface

query @@ -108180,14 +90004,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -108195,10 +90018,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-network-id -

Name of the network

query @@ -108247,7 +90069,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108351,141 +90173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter - -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

-
query - string - - -
- vf-mac-filter - -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

-
query - string - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id - -

Neutron network id of the interface

-
query - string - - -
@@ -108525,7 +90212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108662,7 +90349,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108696,7 +90383,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -108799,7 +90486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -108940,7 +90627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109077,7 +90764,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109202,7 +90889,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109292,10 +90979,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -109307,14 +90993,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vlan-id-inner -

Trigger for operational monitoring of this resource by Service Assurance systems.

query - string + integer @@ -109322,10 +91007,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - interface-id + vpn-id -

ID of interface

query @@ -109335,34 +91019,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -109391,7 +91188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -109404,7 +91201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109420,18 +91217,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing vlan
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

returns vlan

+

create or update an existing vlan

+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
- macaddr + pnf-name -

MAC address for the interface

+

unique name of Physical Network Function.

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path string +
@@ -109508,111 +91322,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -109622,29 +91331,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -109652,7 +91338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109668,16 +91354,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing vlan
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing vlan

+

update an existing vlan

@@ -109686,13 +91372,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

vlan object that needs to be updated.

- /vlan + /vlan
@@ -109789,7 +91475,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109805,34 +91491,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing vlan
-

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing vlan
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

update an existing vlan

+

delete an existing vlan

application/json application/xml

-
-
-

vlan object that needs to be created or updated.

-

-
-
-
-
- /vlan -
-
-
@@ -109910,6 +91584,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -109926,7 +91616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -109941,24 +91631,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing vlan

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -110037,12 +91722,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -110060,6 +91745,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -110067,7 +91775,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -110083,18 +91791,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
@@ -110187,156 +91912,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -110346,29 +91921,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -110376,7 +91928,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -110392,16 +91944,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing l3-interface-ipv4-address-list

@@ -110410,13 +91962,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -110529,7 +92081,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -110545,34 +92097,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

update an existing l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
@@ -110666,6 +92206,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -110682,7 +92238,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -110697,23 +92253,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
@@ -110807,22 +92375,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -110839,7 +92391,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -110855,34 +92407,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
@@ -110992,7 +92532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111007,24 +92547,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -111103,7 +92638,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -111126,6 +92661,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -111133,7 +92691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111149,18 +92707,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
+
@@ -111253,154 +92828,157 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - + - - - - - - - - + - + @@ -111412,29 +92990,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -111442,7 +92997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111458,34 +93013,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
- -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr + pnf-name -

MAC address for the interface

+

unique name of Physical Network Function.

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the physical interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
@@ -111579,6 +93122,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -111595,7 +93154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111610,17 +93169,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

@@ -111629,13 +93188,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -111748,7 +93307,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111763,17 +93322,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing relationship

@@ -111873,22 +93432,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -111905,7 +93448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -111920,11 +93463,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -111939,7 +93482,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -112026,22 +93569,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -112058,7 +93585,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112073,11 +93600,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -112167,22 +93694,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - l3-interface-ipv6-address - - -

IP address

- - path - - string - - - - - - @@ -112199,7 +93710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112214,11 +93725,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -112233,7 +93744,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)

@@ -112288,38 +93799,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - vlan-interface - - -

String that identifies the interface

- - path - - string - - - - - - @@ -112336,7 +93815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112351,11 +93830,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -112413,38 +93892,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - vlan-interface - - -

String that identifies the interface

- - path - - string - - - - - - @@ -112461,7 +93908,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112476,11 +93923,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network
@@ -112495,7 +93942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)

@@ -112534,12 +93981,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + +
- interface-name + pnf-name -

Name that identifies the physical interface

+

unique name of Physical Network Function.

path @@ -112566,7 +94074,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112581,24 +94089,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
returns route-table-references
+

GET /network/route-table-references

Tags: Network
-

delete an existing relationship

+

returns route-table-references

-
- -

application/json application/xml -

-
@@ -112613,34 +94116,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -112652,6 +94151,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
default @@ -112659,7 +94181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112674,36 +94196,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
returns route-table-reference
+

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

see node definition for valid relationships

+

returns route-table-reference

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)

-

-
-
-
- -
-
-
- pnf-name + route-table-reference-id -

unique name of Physical Network Function.

pathquery string -
- interface-name + route-table-reference-fqdn -

Name that identifies the physical interface

pathquery string -
@@ -112718,10 +94223,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pnf-name + route-table-reference-id -

unique name of Physical Network Function.

+

Route Table Reference id, UUID assigned to this instance.

path @@ -112741,6 +94246,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
default @@ -112748,7 +94276,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112763,23 +94291,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
create or update an existing route-table-reference
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

delete an existing relationship

+

create or update an existing route-table-reference

application/json application/xml

+
+
+

route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+ +
@@ -112795,10 +94335,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pnf-name + route-table-reference-id -

unique name of Physical Network Function.

+

Route Table Reference id, UUID assigned to this instance.

path @@ -112825,7 +94365,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112840,48 +94380,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns route-table-references
-

GET /network/route-table-references

+
update an existing route-table-reference
+

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

returns route-table-references

+

update an existing route-table-reference

+
+ +

application/json application/xml +

+
+
+

route-table-reference object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+
path + string + + + +
+

application/json application/xml

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
default @@ -112889,7 +94454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -112905,18 +94470,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
returns route-table-reference
-

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+
delete an existing route-table-reference
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

returns route-table-reference

+

delete an existing route-table-reference

+
+ +

application/json application/xml +

+
@@ -112947,10 +94517,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -112969,29 +94540,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
default @@ -112999,7 +94547,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113014,17 +94562,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing route-table-reference
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

+
see node definition for valid relationships
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
-

create or update an existing route-table-reference

+

see node definition for valid relationships

@@ -113033,13 +94581,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

@@ -113088,7 +94636,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113103,35 +94651,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing route-table-reference
-

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

+
delete an existing relationship
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
-

update an existing route-table-reference

+

delete an existing relationship

application/json application/xml

-
-
-

route-table-reference object that needs to be created or updated.

-

-
- -
- route-table-reference-fqdn + resource-version -

FQDN entry in the route table.

+

resource-version for concurrency

query @@ -112958,6 +94528,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -113177,7 +94713,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113192,24 +94728,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing route-table-reference
-

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

+
returns site-pair-sets
+

GET /network/site-pair-sets

Tags: Network
-

delete an existing route-table-reference

+

returns site-pair-sets

-
- -

application/json application/xml -

-
@@ -113224,26 +94755,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - -
- route-table-reference-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
- resource-version + site-pair-set-id -

resource-version for concurrency

query @@ -113251,220 +94765,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - -
- route-table-reference-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- route-table-reference-id - -

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns site-pair-sets
-

GET /network/site-pair-sets

- Tags: - Network -
-
-
-

returns site-pair-sets

- -
-

application/json application/xml

@@ -113500,7 +94806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113595,7 +94901,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113684,7 +94990,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113718,7 +95024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

site-pair-set object that needs to be created or updated.

+

site-pair-set object that needs to be updated.

@@ -113773,7 +95079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113866,7 +95172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -113955,7 +95261,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114032,7 +95338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114088,6 +95394,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ routing-instance-id + + query + string + + +
@@ -114127,7 +95447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114238,7 +95558,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114343,7 +95663,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114377,7 +95697,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

routing-instance object that needs to be created or updated.

+

routing-instance object that needs to be updated.

@@ -114448,7 +95768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114557,7 +95877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114662,7 +95982,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114755,7 +96075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114827,6 +96147,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ site-pair-id + + query + string + + +
@@ -114866,7 +96200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -114993,7 +96327,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115114,7 +96448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115148,7 +96482,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

site-pair object that needs to be created or updated.

+

site-pair object that needs to be updated.

@@ -115235,7 +96569,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115360,7 +96694,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115448,6 +96782,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ cos + + query + string + + +
@@ -115487,7 +96835,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115630,7 +96978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115767,7 +97115,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -115801,7 +97149,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

class-of-service object that needs to be created or updated.

+

class-of-service object that needs to be updated.

@@ -115904,7 +97252,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116045,7 +97393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116182,7 +97530,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116307,7 +97655,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116428,7 +97776,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116537,7 +97885,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116564,70 +97912,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns vces

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vces -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vce
-

GET /network/vces/vce/{vnf-id}

- Tags: - Network -
-
-
-

returns vce

-
@@ -116646,15 +97930,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-id - + @@ -116662,7 +97944,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name
-

Unique id of VNF. This is unique across the graph.

pathquery string -
-

Name of VNF.

query @@ -116677,7 +97958,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name2 -

Alternate name of VNF.

query @@ -116692,7 +97972,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-type -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

query @@ -116707,7 +97986,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

query @@ -116722,7 +98000,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen regional-resource-zone -

Regional way of organizing pservers, source of truth should define values

query @@ -116737,7 +98014,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -116752,7 +98028,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

query @@ -116767,7 +98042,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vpe-id -

Unique ID of VPE connected to this VCE.

query @@ -116781,6 +98055,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vce
+

GET /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

returns vce

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+
path + string + + + +
+
+

application/json application/xml

@@ -116816,7 +98185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116905,7 +98274,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -116939,7 +98308,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vce object that needs to be created or updated.

+

vce object that needs to be updated.

@@ -116994,7 +98363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117087,7 +98456,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117145,100 +98514,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id + group-uuid -

Heat stack id corresponding to this instance, managed by MSO

query @@ -117250,10 +98528,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vpe-id + resource-uuid -

Unique ID of VPE connected to this VCE.

query @@ -117302,7 +98579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117390,126 +98667,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - vpe-id - - -

Unique ID of VPE connected to this VCE.

- - query - - string - - - - -
@@ -117549,7 +98706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117670,7 +98827,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117704,7 +98861,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated.

+

entitlement object that needs to be updated.

@@ -117791,7 +98948,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -117916,7 +99073,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118037,7 +99194,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118146,7 +99303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118204,100 +99361,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id + group-uuid -

Heat stack id corresponding to this instance, managed by MSO

query @@ -118309,10 +99375,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vpe-id + resource-uuid -

Unique ID of VPE connected to this VCE.

query @@ -118361,7 +99426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118449,126 +99514,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - vpe-id - - -

Unique ID of VPE connected to this VCE.

- - query - - string - - - - - @@ -118608,7 +99553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118729,7 +99674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118763,7 +99708,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated.

+

license object that needs to be updated.

@@ -118850,7 +99795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -118975,7 +99920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119096,7 +100041,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119205,7 +100150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119263,55 +100208,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id + interface-id -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

query @@ -119323,10 +100222,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - regional-resource-zone + port-group-id -

Regional way of organizing pservers, source of truth should define values

query @@ -119338,10 +100236,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + switch-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -119356,22 +100253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - vpe-id - - -

Unique ID of VPE connected to this VCE.

query @@ -119420,7 +100301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119492,171 +100373,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - vpe-id - - -

Unique ID of VPE connected to this VCE.

- - query - - string - - - - - - - - port-group-id - - -

Unique ID for port group in vmware

- - query - - string - - - - - - - - switch-name - - -

DVS or standard switch name (should be non-null for port groups associated with DVS)

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - @@ -119696,7 +100412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119801,7 +100517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -119835,7 +100551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

port-group object that needs to be created or updated.

+

port-group object that needs to be updated.

@@ -119906,7 +100622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -120015,7 +100731,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -120089,164 +100805,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - vpe-id - - -

Unique ID of VPE connected to this VCE.

- - query - - string - - - - - - - - port-group-id - - -

Unique ID for port group in vmware

- - query - - string - - - - - - - - switch-name - - -

DVS or standard switch name (should be non-null for port groups associated with DVS)

- - query - - string - - - - - - - - heat-stack-id + cvlan-tag -

Heat stack id corresponding to this instance, managed by MSO

query - string + integer @@ -120280,268 +100845,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - -
-
- - -
-
-
returns cvlan-tag-entry
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

- Tags: - Network -
-
-
-

returns cvlan-tag-entry

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
returns cvlan-tag-entry
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

returns cvlan-tag-entry

+ +
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-id - -

Unique ID of the interface

-
path - string - - - -
- cvlan-tag - -

See mis-na-virtualization-platform.yang

-
path - integer - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- vpe-id - -

Unique ID of VPE connected to this VCE.

-
query - string - - -
+ + + + + + + + + + - + - + - + @@ -120583,7 +100983,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -120704,7 +101104,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -120738,7 +101138,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cvlan-tag-entry object that needs to be created or updated.

+

cvlan-tag-entry object that needs to be updated.

@@ -120825,7 +101225,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -120950,7 +101350,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121071,7 +101471,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121180,7 +101580,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121285,7 +101685,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121378,7 +101778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121467,7 +101867,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121544,7 +101944,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -121571,70 +101971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns vnfcs

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vnfcs -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns vnfc
-

GET /network/vnfcs/vnfc/{vnfc-name}

- Tags: - Network -
-
-
-

returns vnfc

-
- port-group-id + vnf-id -

Unique ID for port group in vmware

+

Unique id of VNF. This is unique across the graph.

querypath string +
- switch-name + interface-id -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

Unique ID of the interface

querypath string +
- heat-stack-id + cvlan-tag -

Heat stack id corresponding to this instance, managed by MSO

+

See mis-na-virtualization-platform.yang

querypath - string + integer +
@@ -121653,15 +101989,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnfc-name - + @@ -121669,7 +102003,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnfc-function-code - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Unique ID of vnfc.

pathquery string -
-

function code

query @@ -121684,7 +102017,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnfc-type -

type

query @@ -121699,7 +102031,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

prov status of this vnfc

query @@ -121714,7 +102045,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen ipaddress-v4-oam-vip -

Oam V4 vip address of this vnfc

query @@ -121757,7 +102087,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen group-notation -

Group notation of VNFC

query @@ -121793,7 +102122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -121806,185 +102135,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - - - - - -
-
-
create or update an existing vnfc
-

PUT /network/vnfcs/vnfc/{vnfc-name}

- Tags: - Network -
-
-
-

create or update an existing vnfc

- -
-
- -

application/json application/xml -

-
-
-

vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

-

-
-
-
-
- /vnfc -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vnfc-name - -

Unique ID of vnfc.

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing vnfc
-

PATCH /network/vnfcs/vnfc/{vnfc-name}

- Tags: - Network -
-
-
-

update an existing vnfc

- -
-
- -

application/json application/xml -

-
-
-

vnfc object that needs to be created or updated.

-

-
-
-
-
- /vnfc -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vnfc-name - -

Unique ID of vnfc.

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -122000,205 +102151,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
-
-
delete an existing vnfc
-

DELETE /network/vnfcs/vnfc/{vnfc-name}

- Tags: - Network -
-
-
-

delete an existing vnfc

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnfc-name - -

Unique ID of vnfc.

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vnfc-name - -

Unique ID of vnfc.

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+
-
delete an existing relationship
-

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

+
returns vnfc
+

GET /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

delete an existing relationship

+

returns vnfc

-
- -

application/json application/xml -

-
@@ -122231,156 +102195,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vpls-pes
-

GET /network/vpls-pes

- Tags: - Network -
-
-
-

returns vpls-pes

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpls-pes -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vpls-pe
-

GET /network/vpls-pes/vpls-pe/{equipment-name}

- Tags: - Network -
-
-
-

returns vpls-pe

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
-
-

application/json application/xml

@@ -122403,7 +102217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -122416,7 +102230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -122431,17 +102245,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vpls-pe
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}

+
create or update an existing vnfc
+

PUT /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

create or update an existing vpls-pe

+

create or update an existing vnfc

@@ -122450,13 +102264,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)

+

vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

@@ -122475,9 +102289,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnfc-name +

Unique ID of vnfc.

path @@ -122504,7 +102319,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -122519,17 +102334,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vpls-pe
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

+
update an existing vnfc
+

PATCH /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

update an existing vpls-pe

+

update an existing vnfc

@@ -122538,375 +102353,43 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpls-pe object that needs to be created or updated.

+

vnfc object that needs to be updated.

-
- - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vpls-pe
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

- Tags: - Network -
-
-
-

delete an existing vpls-pe

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

- Tags: - Network -
-
-
-

returns lag-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

returns lag-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
+ + + + + + + + + + - + @@ -122918,29 +102401,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -122948,7 +102408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -122963,35 +102423,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing vnfc
+

DELETE /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

create or update an existing lag-interface

+

delete an existing vnfc

application/json application/xml

-
-
-

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

-

-
-
-
- -
-
- interface-role + vnfc-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Unique ID of vnfc.

querypath string +
@@ -123007,9 +102455,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - -
- equipment-name + vnfc-name +

Unique ID of vnfc.

path @@ -123022,12 +102471,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name that identifies the link aggregate interface

+

resource-version for concurrency

pathquery string @@ -123052,7 +102501,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123067,17 +102516,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing lag-interface
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
-

update an existing lag-interface

+

see node definition for valid relationships

@@ -123086,13 +102535,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

@@ -123111,25 +102560,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnfc-name -

Name that identifies the link aggregate interface

+

Unique ID of vnfc.

path @@ -123156,7 +102590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123171,17 +102605,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing relationship
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
-

delete an existing lag-interface

+

delete an existing relationship

@@ -123203,25 +102637,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnfc-name -

Name that identifies the link aggregate interface

+

Unique ID of vnfc.

path @@ -123232,22 +102651,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -123264,7 +102667,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123279,17 +102682,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
returns vpls-pes
+

GET /network/vpls-pes

Tags: Network
-

returns l-interfaces

+

returns vpls-pes

@@ -123309,53 +102712,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen equipment-name
- path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

query @@ -123367,10 +102723,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -123406,7 +102761,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -123419,7 +102774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123434,17 +102789,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns vpls-pe
+

GET /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

returns l-interface

+

returns vpls-pe

@@ -123474,128 +102829,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
@@ -123622,7 +102855,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -123635,7 +102868,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123650,17 +102883,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing vpls-pe

@@ -123669,13 +102902,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)

@@ -123707,38 +102940,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name that identifies the link aggregate interface

- - path - - string - - - - - - - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - -
@@ -123755,7 +102956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123770,17 +102971,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l-interface
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing vpls-pe
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

update an existing l-interface

+

update an existing vpls-pe

@@ -123789,13 +102990,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

vpls-pe object that needs to be updated.

@@ -123827,38 +103028,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name that identifies the link aggregate interface

- - path - - string - - - - - - - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - -
@@ -123875,7 +103044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -123890,17 +103059,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
delete an existing vpls-pe
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

delete an existing l-interface

+

delete an existing vpls-pe

@@ -123935,38 +103104,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name that identifies the link aggregate interface

- - path - - string - - - - - - - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - resource-version @@ -123999,7 +103136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124014,17 +103151,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns lag-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns lag-interfaces

@@ -124059,55 +103196,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the link aggregate interface

- - path - - string - - - - - - - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - l3-interface-ipv4-address - - -

IP address

- - path - - string - - - - - - - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -124122,7 +103210,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -124137,97 +103224,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-role -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

query @@ -124263,7 +103259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -124276,7 +103272,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124291,36 +103287,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns lag-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns lag-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
-
@@ -124364,38 +103343,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -124405,142 +103352,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- default +
+ 200 OK
-
+
-

Response codes found in response codes.

+

successful operation

- +
-
- -
-
- -
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
+
-
-

application/json application/xml -

- -
+ +
+
+ +
default @@ -124548,7 +103382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124563,23 +103397,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing lag-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
@@ -124624,54 +103470,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -124688,7 +103486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124703,17 +103501,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing lag-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -124722,13 +103520,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

lag-interface object that needs to be updated.

@@ -124776,38 +103574,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - l3-interface-ipv4-address - - -

IP address

- - path - - string - - - - - -
@@ -124824,7 +103590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124839,17 +103605,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing lag-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing lag-interface

@@ -124902,28 +103668,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

- path + query string @@ -124948,7 +103698,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -124963,17 +103713,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns l-interfaces

@@ -125024,69 +103774,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

- - path - - string - - - - - - - - - l3-interface-ipv6-address - - -

IP address

- - path - - string - - - - - - - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -125101,7 +103788,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -125116,7 +103802,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen macaddr -

MAC address for the interface

query @@ -125131,7 +103816,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

query @@ -125141,49 +103825,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + - + - + - + @@ -125212,7 +103977,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -125225,7 +103990,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125240,17 +104005,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l-interface

@@ -125259,13 +104024,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -125329,22 +104094,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- vlan-id-inner + equipment-name -

Inner VLAN tag

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name that identifies the link aggregate interface

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name given to the interface

querypath string +
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
@@ -125361,7 +104110,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125376,17 +104125,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

update an existing l3-interface-ipv6-address-list

+

update an existing l-interface

@@ -125395,13 +104144,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -125465,22 +104214,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - l3-interface-ipv6-address - - -

IP address

- - path - - string - - - - - -
@@ -125497,7 +104230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125512,17 +104245,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing l-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing l-interface

@@ -125591,10 +104324,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - l3-interface-ipv6-address + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + + + + +
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + - + + + + + + + + + + + + + + + - - - - - - -
+ equipment-name -

IP address

path @@ -125607,12 +104411,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+
path string @@ -125630,6 +104466,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -125637,7 +104496,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125652,17 +104511,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv4-address-list

@@ -125671,13 +104530,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -125743,7 +104602,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -125773,7 +104632,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125788,23 +104647,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
@@ -125867,7 +104738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -125897,7 +104768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -125912,35 +104783,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
@@ -126001,6 +104860,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -126017,7 +104908,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126032,23 +104923,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
@@ -126109,6 +105012,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -126125,7 +105044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126140,19 +105059,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns sriov-vfs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -126214,92 +105138,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- interface-id + l3-interface-ipv4-address -

ID of interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -126328,7 +105297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -126341,7 +105310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126356,19 +105325,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
- interface-role + equipment-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -126430,10 +105416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -126444,154 +105430,140 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -126603,29 +105575,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -126633,7 +105582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126648,35 +105597,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing sriov-vf

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + equipment-name -

Name of the network

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name that identifies the link aggregate interface

querypath string +
- vf-mac-filter + interface-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Name given to the interface

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
@@ -126739,10 +105676,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -126753,6 +105690,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -126769,7 +105722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126784,17 +105737,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

update an existing sriov-vf

+

see node definition for valid relationships

@@ -126803,13 +105756,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -126875,10 +105828,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -126905,7 +105858,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -126920,17 +105873,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -126999,10 +105952,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -127013,22 +105966,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -127045,7 +105982,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127060,11 +105997,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -127079,7 +106016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -127149,22 +106086,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
@@ -127181,7 +106102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127196,11 +106117,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -127273,22 +106194,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - pci-id - - -

PCI ID used to identify the sriov-vf

- - path - - string - - - - - - @@ -127305,7 +106210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127320,17 +106225,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlans
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns sriov-vfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

returns vlans

+

returns sriov-vfs

@@ -127394,25 +106299,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - interface-id + pci-id -

ID of interface

query @@ -127424,10 +106313,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - interface-role + vf-vlan-filter -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -127439,10 +106327,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - interface-id + vf-mac-filter -

ID of interface

query @@ -127454,14 +106341,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -127469,10 +106355,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name + neutron-network-id -

Name of the network

query @@ -127508,7 +106393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -127521,7 +106406,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127536,17 +106421,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns sriov-vf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns vlan

+

returns sriov-vf

@@ -127610,10 +106495,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -127624,126 +106509,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - vpn-id - - -

This indicates the customers VPN ID associated with this vlan

- - query - - string - - - - -
@@ -127770,7 +106535,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -127783,7 +106548,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127798,17 +106563,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing sriov-vf
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

create or update an existing vlan

+

create or update an existing sriov-vf

@@ -127817,13 +106582,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -127889,10 +106654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -127919,7 +106684,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -127934,17 +106699,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing vlan
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

update an existing vlan

+

update an existing sriov-vf

@@ -127953,13 +106718,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -128025,10 +106790,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -128055,7 +106820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -128070,17 +106835,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing sriov-vf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing vlan

+

delete an existing sriov-vf

@@ -128149,10 +106914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -128195,7 +106960,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -128210,19 +106975,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+ +
+
+
@@ -128284,10 +107066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

path @@ -128298,12 +107080,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- l3-interface-ipv4-address + equipment-name -

IP address

path @@ -128316,85 +107158,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + pci-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + + + + + + + + + +
- interface-id + equipment-name -

ID of interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
- network-name + interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface -

Name of the network

query @@ -128409,7 +107326,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vlan-id-inner -

Inner VLAN tag

query @@ -128424,7 +107340,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vpn-id -

This indicates the customers VPN ID associated with this vlan

query @@ -128434,49 +107349,146 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + - + - + - + @@ -128505,7 +107517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -128518,7 +107530,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
create or update an existing vlan
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+
+ equipment-name + + path + string + + + +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the link aggregate interface

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + vlan-interface -

Neutron id of subnet that address belongs to

+

String that identifies the interface

querypath string +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

@@ -128533,17 +107681,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing vlan

@@ -128552,13 +107700,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

vlan object that needs to be updated.

@@ -128638,12 +107786,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- l3-interface-ipv4-address + equipment-name -

IP address

path @@ -128654,6 +107862,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -128670,7 +107942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -128686,35 +107958,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l3-interface-ipv4-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

update an existing l3-interface-ipv4-address-list

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
@@ -128815,6 +108070,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -128822,7 +108100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -128838,22 +108116,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -128946,22 +108236,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -128978,7 +108252,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -128993,17 +108267,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -129012,13 +108286,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -129130,7 +108404,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -129145,17 +108419,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -129254,6 +108528,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + +
@@ -129270,7 +108560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -129285,19 +108575,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -129375,7 +108682,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -129389,169 +108696,279 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + + +
- prov-status + equipment-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name given to the interface

querypath string +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - - - - - - - - + - + - + - + @@ -129593,7 +109010,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -129745,7 +109162,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -129779,7 +109196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -129897,7 +109314,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130053,7 +109470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130205,7 +109622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130345,7 +109762,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130481,7 +109898,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130605,7 +110022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130709,7 +110126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130801,7 +110218,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130856,12 +110273,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + - - - - - - - - - - - - - -
- network-name + equipment-name -

Name of the network

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the link aggregate interface

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
+ interface-name + + query + string + + +
prov-status -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -130910,7 +110340,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -130981,36 +110411,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
@@ -131050,7 +110450,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131154,7 +110554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131188,7 +110588,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated.

+

p-interface object that needs to be updated.

@@ -131258,7 +110658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131366,7 +110766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131439,10 +110839,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -131454,10 +110853,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + interface-id + + + + query + + string + + + + + + + + macaddr + + + + query + + string + + + + + + + + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -131506,7 +110932,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131593,81 +111019,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - @@ -131707,7 +111058,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131827,7 +111178,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -131861,7 +111212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -131947,7 +111298,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -132071,7 +111422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -132174,126 +111525,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -132333,7 +111564,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -132469,283 +111700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - -
-
- - -
-
-
update an existing l3-interface-ipv4-address-list
-

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

update an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -132760,17 +111715,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -132779,13 +111734,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -132881,7 +111836,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -132896,17 +111851,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -132989,6 +111944,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + +
@@ -133005,7 +111976,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133020,19 +111991,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -133094,7 +112082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -133108,124 +112096,247 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + + +
- prov-status + equipment-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name that identifies the physical interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -133267,7 +112378,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133403,7 +112514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133437,7 +112548,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -133539,7 +112650,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133679,7 +112790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133815,7 +112926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -133939,7 +113050,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134059,7 +113170,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134167,7 +113278,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134256,10 +113367,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-name + equipment-name -

Name of the network

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the physical interface

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -134271,10 +113381,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vf-vlan-filter -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -134286,10 +113395,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-mac-filter -

ID of interface

query @@ -134301,14 +113409,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -134316,10 +113423,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-network-id -

Name of the network

query @@ -134368,7 +113474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134471,141 +113577,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter - -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

-
query - string - - -
- vf-mac-filter - -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

-
query - string - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id - -

Neutron network id of the interface

-
query - string - - -
@@ -134645,7 +113616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134781,7 +113752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -134815,7 +113786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -134917,7 +113888,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135057,7 +114028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135193,7 +114164,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135317,7 +114288,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135406,40 +114377,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id + vlan-interface -

ID of interface

query @@ -135451,14 +114391,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - macaddr + vlan-id-inner -

MAC address for the interface

query - string + integer @@ -135466,10 +114405,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name + vpn-id -

Name of the network

query @@ -135518,7 +114456,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135621,111 +114559,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - vpn-id - - -

This indicates the customers VPN ID associated with this vlan

- - query - - string - - - - - @@ -135765,7 +114598,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135901,7 +114734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -135935,7 +114768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -136037,7 +114870,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -136177,7 +115010,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -136296,156 +115129,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - prov-status - - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - vpn-id - - -

This indicates the customers VPN ID associated with this vlan

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -136485,7 +115168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -136637,7 +115320,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -136671,7 +115354,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -136789,7 +115472,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -136945,7 +115628,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -137097,147 +115780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - -
-
- - -
-
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -137252,19 +115795,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -137342,7 +115890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -137356,154 +115904,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - + - - - - - - - - + - + @@ -137545,7 +116078,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -137697,7 +116230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -137731,7 +116264,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -137849,7 +116382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138005,7 +116538,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138157,7 +116690,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138297,7 +116830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138433,7 +116966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138557,7 +117090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138661,7 +117194,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr + equipment-name -

MAC address for the interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the physical interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

@@ -138676,23 +117301,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)

+

+
+
+
+ +
+
@@ -138721,22 +117358,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- interface-name - -

Name that identifies the physical interface

-
path - string - - - -
@@ -138753,7 +117374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138769,34 +117390,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)

-

-
-
-
- -
-
@@ -138841,7 +117450,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -138856,24 +117465,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+
returns vpn-bindings
+

GET /network/vpn-bindings

Tags: Network
-

delete an existing relationship

+

returns vpn-bindings

-
- -

application/json application/xml -

-
@@ -138888,64 +117492,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + +
- equipment-name + vpn-id pathquery + string + + +
+ vpn-name + + query + string + + +
+ vpn-type + + query string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vpn-bindings
-

GET /network/vpn-bindings

- Tags: - Network -
-
-
-

returns vpn-bindings

- -
-

application/json application/xml

@@ -138981,7 +117571,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139037,36 +117627,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vpn-name - - -

VPN Name

- - query - - string - - - - - - - - vpn-type - - -

Type of the vpn, should be taken from enumerated/valid values

- - query - - string - - - - -
@@ -139106,7 +117666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139195,7 +117755,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139229,7 +117789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpn-binding object that needs to be created or updated.

+

vpn-binding object that needs to be updated.

@@ -139284,7 +117844,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139377,96 +117937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - -
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139482,22 +117953,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+ +
+
@@ -139543,7 +118026,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139558,19 +118041,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns route-targets
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

+
delete an existing relationship
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network
-

returns route-targets

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -139599,34 +118087,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-targets
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

+ Tags: + Network +
+
+
+

returns route-targets

+ +
+
+ + + + + + + + + + + - - - - - - - - + @@ -139668,7 +118198,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139756,36 +118286,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - -
- vpn-name - -

VPN Name

-
query - string - - -
- vpn-type + vpn-id -

Type of the vpn, should be taken from enumerated/valid values

+

VPN ID, globally unique within A&AI

querypath string +
- vpn-name - -

VPN Name

-
query - string - - -
- vpn-type - -

Type of the vpn, should be taken from enumerated/valid values

-
query - string - - -
@@ -139825,7 +118325,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139946,7 +118446,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -139980,7 +118480,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-target object that needs to be created or updated.

+

route-target object that needs to be updated.

@@ -140067,7 +118567,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + +
+
+ + +
+
+
delete an existing route-target
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

delete an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+
path + string + + + +
+ global-route-target + +

Number used to identify an RT, globally unique in the network

+
path + string + + + +
+ route-target-role + +

Role assigned to this route target

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

@@ -140082,23 +118707,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing route-target
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network
-

delete an existing route-target

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+ +
+
@@ -140160,22 +118797,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -140192,7 +118813,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140208,34 +118829,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
see node definition for valid relationships
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

-

-
-
-
- -
-
@@ -140313,7 +118922,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140328,24 +118937,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+
returns zones
+

GET /network/zones

Tags: Network
-

delete an existing relationship

+

returns zones

-
- -

application/json application/xml -

-
@@ -140360,97 +118964,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - +
- vpn-id + zone-id -

VPN ID, globally unique within A&AI

pathquery string -
- global-route-target + design-type -

Number used to identify an RT, globally unique in the network

pathquery string -
- route-target-role + zone-context -

Role assigned to this route target

pathquery string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns zones
-

GET /network/zones

- Tags: - Network -
-
-
-

returns zones

- -
-

application/json application/xml

@@ -140486,7 +119043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140542,36 +119099,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - design-type - - -

Design of zone [Medium/Large?]

- - query - - string - - - - - - - - zone-context - - -

Context of zone [production/test]

- - query - - string - - - - -
@@ -140611,7 +119138,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140700,7 +119227,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140734,7 +119261,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

zone object that needs to be created or updated.

+

zone object that needs to be updated.

@@ -140789,7 +119316,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140850,22 +119377,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

resource-version for concurrency

- - query - - string - - - - - - + + + resource-version + + +

resource-version for concurrency

+ + query + + string + + + + + + + + + + +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+
path + string + + + +
@@ -140882,7 +119498,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140898,34 +119514,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
see node definition for valid relationships
-

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

Tags: Network
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)

-

-
-
-
- -
-
@@ -140971,7 +119575,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -140986,24 +119590,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

+
returns models
+

GET /service-design-and-creation/models

Tags: - Network + ServiceDesignAndCreation
-

delete an existing relationship

+

returns models

-
- -

application/json application/xml -

-
@@ -141018,65 +119617,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

pathquery + string + + +
+ model-type + + query string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns models
-

GET /service-design-and-creation/models

- Tags: - ServiceDesignAndCreation -
-
-
-

returns models

- -
-

application/json application/xml

@@ -141112,7 +119682,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141168,21 +119738,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - -
@@ -141222,7 +119777,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141311,7 +119866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141345,7 +119900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model object that needs to be created or updated.

+

model object that needs to be updated.

@@ -141400,7 +119955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141493,7 +120048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141551,10 +120106,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-type + model-version-id + + + + query + + string + + + + + + + + model-name + + + + query + + string + + + + + + + + model-version -

Type of the model, e.g., service, resource, widget, etc.

query @@ -141603,7 +120185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141675,51 +120257,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version - - -

Version

- - query - - string - - - - - @@ -141759,7 +120296,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141864,7 +120401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -141898,7 +120435,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-ver object that needs to be created or updated.

+

model-ver object that needs to be updated.

@@ -141969,7 +120506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142078,7 +120615,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142152,40 +120689,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version + metaname -

Version

query @@ -142234,7 +120740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142321,51 +120827,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version - - -

Version

- - query - - string - - - - - @@ -142405,7 +120866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142525,7 +120986,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142559,7 +121020,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

@@ -142645,7 +121106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142769,7 +121230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -142843,40 +121304,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version + model-element-uuid -

Version

query @@ -142925,7 +121355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143012,51 +121442,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version - - -

Version

- - query - - string - - - - - @@ -143096,7 +121481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143216,7 +121601,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143250,7 +121635,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-element object that needs to be created or updated.

+

model-element object that needs to be updated.

@@ -143336,7 +121721,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143460,7 +121845,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143549,40 +121934,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-type - - -

Type of the model, e.g., service, resource, widget, etc.

- - query - - string - - - - - - - - model-name - - -

Name of the model, which can change from version to version.

- - query - - string - - - - - - - - model-version + model-constraint-uuid -

Version

query @@ -143631,7 +121985,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143733,49 +122087,162 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-constraint
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

+

+
+
+
+
+
+
+ + + + + + + + + + + - + - + - + + + + + + + + @@ -143787,29 +122254,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -143817,7 +122261,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143833,16 +122277,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing model-constraint
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+
update an existing model-constraint
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation
-

create or update an existing model-constraint

+

update an existing model-constraint

@@ -143851,13 +122295,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

+

model-constraint object that needs to be updated.

@@ -143952,7 +122396,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -143968,34 +122412,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing model-constraint
-

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+
delete an existing model-constraint
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation
-

update an existing model-constraint

+

delete an existing model-constraint

application/json application/xml

-
-
-

model-constraint object that needs to be created or updated.

-

-
-
-
-
- model-type + model-invariant-id -

Type of the model, e.g., service, resource, widget, etc.

+

Unique identifier corresponding to the main definition of a model in ASDC

querypath string +
- model-name + model-version-id -

Name of the model, which can change from version to version.

+

Unique identifier corresponding to one version of a model in ASDC

querypath string +
- model-version + model-element-uuid -

Version

querypath string + +
+ model-constraint-uuid + + path + string + + +
@@ -144071,6 +122503,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -144087,7 +122535,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144102,24 +122550,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing model-constraint
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+
returns constrained-element-sets
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

Tags: ServiceDesignAndCreation
-

delete an existing model-constraint

+

returns constrained-element-sets

-
- -

application/json application/xml -

-
@@ -144196,10 +122639,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -144219,6 +122660,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -144226,7 +122690,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144241,17 +122705,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns constrained-element-sets
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

+
returns constrained-element-set
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation
-

returns constrained-element-sets

+

returns constrained-element-set

@@ -144330,47 +122794,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - + @@ -144399,7 +122833,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -144412,7 +122846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144428,18 +122862,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns constrained-element-set
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
create or update an existing constrained-element-set
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation
-

returns constrained-element-set

+

create or update an existing constrained-element-set

+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+ +
+
- resource-version + constrained-element-set-uuid -

resource-version for concurrency

query @@ -144207,7 +122649,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- model-type - -

Type of the model, e.g., service, resource, widget, etc.

-
query - string - - -
- model-name - -

Name of the model, which can change from version to version.

-
query - string - - -
- model-version + constrained-element-set-uuid -

Version

querypath string +
@@ -144529,51 +122980,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- model-type - -

Type of the model, e.g., service, resource, widget, etc.

-
query - string - - -
- model-name - -

Name of the model, which can change from version to version.

-
query - string - - -
- model-version - -

Version

-
query - string - - -
@@ -144583,29 +122989,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
default @@ -144613,7 +122996,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144629,16 +123012,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing constrained-element-set
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
update an existing constrained-element-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation
-

create or update an existing constrained-element-set

+

update an existing constrained-element-set

@@ -144647,13 +123030,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

constrained-element-set object that needs to be updated.

@@ -144763,7 +123146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144779,34 +123162,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing constrained-element-set
-

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
delete an existing constrained-element-set
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation
-

update an existing constrained-element-set

+

delete an existing constrained-element-set

application/json application/xml

-
-
-

constrained-element-set object that needs to be created or updated.

-

-
- -
@@ -144897,6 +123268,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -144913,7 +123300,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -144928,24 +123315,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing constrained-element-set
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
returns element-choice-sets
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

Tags: ServiceDesignAndCreation
-

delete an existing constrained-element-set

+

returns element-choice-sets

-
- -

application/json application/xml -

-
@@ -145037,10 +123419,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -145060,6 +123440,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+ +
+ +
default @@ -145067,7 +123470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145082,17 +123485,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns element-choice-sets
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

+
returns element-choice-set
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation
-

returns element-choice-sets

+

returns element-choice-set

@@ -145186,47 +123589,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - + @@ -145255,7 +123628,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -145268,7 +123641,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145284,18 +123657,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns element-choice-set
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
create or update an existing element-choice-set
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation
-

returns element-choice-set

+

create or update an existing element-choice-set

+
+ +

application/json application/xml +

+
+
+

element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+ +
+
- resource-version + element-choice-set-uuid -

resource-version for concurrency

query @@ -145048,7 +123429,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- model-type - -

Type of the model, e.g., service, resource, widget, etc.

-
query - string - - -
- model-name - -

Name of the model, which can change from version to version.

-
query - string - - -
- model-version + element-choice-set-uuid -

Version

querypath string +
@@ -145400,49 +123790,169 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing element-choice-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing element-choice-set

+ +
+
+ +

application/json application/xml +

+
+
+

element-choice-set object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + @@ -145454,29 +123964,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
default @@ -145484,7 +123971,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145500,34 +123987,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing element-choice-set
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
delete an existing element-choice-set
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation
-

create or update an existing element-choice-set

+

delete an existing element-choice-set

application/json application/xml

-
-
-

element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

-

-
- -
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+
path + string + + + +
- model-type + model-version-id -

Type of the model, e.g., service, resource, widget, etc.

+

Unique identifier corresponding to one version of a model in ASDC

querypath string +
- model-name + model-element-uuid -

Name of the model, which can change from version to version.

querypath string +
- model-version + model-constraint-uuid -

Version

querypath + string + + + +
+ constrained-element-set-uuid + + path string + +
+ element-choice-set-uuid + + path + string + + +
@@ -145633,6 +124108,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -145649,7 +124140,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145664,17 +124155,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing element-choice-set
-

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
-

update an existing element-choice-set

+

see node definition for valid relationships

@@ -145683,13 +124174,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

element-choice-set object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

@@ -145814,7 +124305,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145829,17 +124320,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing element-choice-set
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
delete an existing relationship
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
-

delete an existing element-choice-set

+

delete an existing relationship

@@ -145951,22 +124442,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

resource-version for concurrency

- - query - - string - - - - - -
@@ -145983,7 +124458,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -145998,11 +124473,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146017,7 +124492,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

@@ -146117,21 +124592,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - element-choice-set-uuid - - - - path - - string - - - - - - @@ -146148,7 +124608,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146163,11 +124623,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146270,21 +124730,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - element-choice-set-uuid - - - - path - - string - - - - - - @@ -146301,7 +124746,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146316,11 +124761,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146335,7 +124780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

@@ -146405,36 +124850,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-constraint-uuid - - - - path - - string - - - - - - - - - constrained-element-set-uuid - - - - path - - string - - - - - - @@ -146451,7 +124866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146466,11 +124881,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146543,36 +124958,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-constraint-uuid - - - - path - - string - - - - - - - - - constrained-element-set-uuid - - - - path - - string - - - - - - @@ -146589,7 +124974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146604,11 +124989,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146623,7 +125008,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

@@ -146678,21 +125063,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-element-uuid - - - - path - - string - - - - - - @@ -146709,7 +125079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146724,11 +125094,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146786,21 +125156,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-element-uuid - - - - path - - string - - - - - - @@ -146817,7 +125172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146832,11 +125187,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146851,7 +125206,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)

@@ -146890,22 +125245,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-version-id - - -

Unique identifier corresponding to one version of a model in ASDC

- - path - - string - - - - - - @@ -146922,7 +125261,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -146937,11 +125276,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation
@@ -146983,22 +125322,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-version-id - - -

Unique identifier corresponding to one version of a model in ASDC

- - path - - string - - - - - - @@ -147015,7 +125338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147030,36 +125353,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

+
returns named-queries
+

GET /service-design-and-creation/named-queries

Tags: ServiceDesignAndCreation
-

see node definition for valid relationships

+

returns named-queries

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)

-

-
-
-
- -
-
-
@@ -147074,142 +125380,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- model-invariant-id + named-query-uuid -

Unique identifier corresponding to the main definition of a model in ASDC

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - +
- model-invariant-id + named-query-name -

Unique identifier corresponding to the main definition of a model in ASDC

pathquery string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns named-queries
-

GET /service-design-and-creation/named-queries

- Tags: - ServiceDesignAndCreation -
-
-
-

returns named-queries

- -
-

application/json application/xml

@@ -147245,7 +125445,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147300,20 +125500,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - named-query-name - - - - query - - string - - - - -
@@ -147353,7 +125539,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147441,7 +125627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147475,7 +125661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

named-query object that needs to be created or updated.

+

named-query object that needs to be updated.

@@ -147529,7 +125715,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147621,7 +125807,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147678,7 +125864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - named-query-name + named-query-element-uuid @@ -147729,7 +125915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147799,20 +125985,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - named-query-name - - - - query - - string - - - - - @@ -147852,7 +126024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147955,7 +126127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -147989,7 +126161,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

named-query-element object that needs to be created or updated.

+

named-query-element object that needs to be updated.

@@ -148058,7 +126230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148165,7 +126337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148237,7 +126409,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - named-query-name + property-constraint-uuid @@ -148288,7 +126460,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148373,20 +126545,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - named-query-name - - - - query - - string - - - - - @@ -148426,7 +126584,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148544,7 +126702,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148578,7 +126736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

property-constraint object that needs to be created or updated.

+

property-constraint object that needs to be updated.

@@ -148662,7 +126820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148784,7 +126942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148856,7 +127014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - named-query-name + related-lookup-uuid @@ -148907,7 +127065,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -148992,20 +127150,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - named-query-name - - - - query - - string - - - - - @@ -149045,7 +127189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149163,7 +127307,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149197,7 +127341,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

related-lookup object that needs to be created or updated.

+

related-lookup object that needs to be updated.

@@ -149281,7 +127425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149403,7 +127547,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149521,7 +127665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149627,7 +127771,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149730,7 +127874,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149821,7 +127965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149909,7 +128053,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -149985,7 +128129,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150013,6 +128157,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns service-capabilities

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + + query + string + + +
+ vnf-type + + query + string + + +
+

application/json application/xml @@ -150049,7 +128236,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150160,7 +128347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150265,7 +128452,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150299,7 +128486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-capability object that needs to be created or updated.

+

service-capability object that needs to be updated.

@@ -150370,7 +128557,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150479,7 +128666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150584,7 +128771,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150677,7 +128864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150705,6 +128892,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns services

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-id + + query + string + + +
+ service-description + + query + string + + +
+

application/json application/xml @@ -150741,7 +128971,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150797,21 +129027,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - service-description - - -

Description of the service

- - query - - string - - - - -
@@ -150851,7 +129066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150940,7 +129155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -150974,7 +129189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service object that needs to be created or updated.

+

service object that needs to be updated.

@@ -151029,7 +129244,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151122,7 +129337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151211,7 +129426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151288,7 +129503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151316,6 +129531,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns vnf-images

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + + query + string + + +
+ application + + query + string + + +
+ application-vendor + + query + string + + +
+ application-version + + query + string + + +
+

application/json application/xml @@ -151352,7 +129638,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151408,51 +129694,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - application - - -

The application that the image instantiates.

- - query - - string - - - - - - - - application-vendor - - -

The vendor of the application.

- - query - - string - - - - - - - - application-version - - -

The version of the application.

- - query - - string - - - - -
@@ -151492,7 +129733,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151581,7 +129822,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151615,7 +129856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vnf-image object that needs to be created or updated.

+

vnf-image object that needs to be updated.

@@ -151670,7 +129911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151763,7 +130004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151852,7 +130093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151929,7 +130170,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -151947,45 +130188,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

Schema definitions

-
-
-

aai-internal: - object - - - -

-
-
- -
-
-
- property-name: - string - - -
-
-
- -
-
-
- property-value: - string - - -
-
-
- -
-
-
-
-
-

action: @@ -152148,15 +130350,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

Represents a slice or partial piece of a resource that gets separately allotted

    -
  • TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
  • -
  • TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
  • -
  • TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
  • -
  • TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
  • -
  • TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
  • -
  • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
  • -
  • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
  • -
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
  • -
  • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+
  • TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
  • +
  • TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
  • +
  • TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
  • +
  • TO vlan( allotted-resource PartOf vlan, MANY2MANY)
  • +
  • TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
  • +
  • FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
  • +
  • FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
  • +

    +
  • (1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
  • @@ -152394,15 +130598,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Availability zone, a collection of compute hosts/pservers

      -
    • TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • -
    • TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • -
    • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • -
    • FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
    • -
    • FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • -
    • AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
    +
  • TO complex( availability-zone LocatedIn complex, MANY2ONE)
  • +
  • TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
  • +
  • TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
  • +
  • FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
  • +
  • FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
  • +
  • FROM vce( vce Uses availability-zone, MANY2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
  • +
  • AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
  • @@ -152654,7 +130860,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
    +
  • TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
  • @@ -152909,22 +131117,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    cloud-region designates an installation of a cloud cluster or region or instantiation

      -
    • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • -
    • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • -
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • -
    • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
    • -
    • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
    +
  • TO complex( cloud-region LocatedIn complex, MANY2ONE)
  • +
  • TO l3-network( cloud-region Uses l3-network, MANY2MANY)
  • +
  • TO zone( cloud-region LocatedIn zone, MANY2ONE)
  • +
  • FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
  • +
  • FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM image( image BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
  • +
  • FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
  • +

    +
  • (1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
  • +
  • CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
  • @@ -153295,19 +131504,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical locations that can house cloud-regions.

      -
    • TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • -
    • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • -
    • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • -
    • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
    • -
    • COMPLEX is DELETED when these are DELETED CTAG-POOL
    +
  • TO l3-network( complex Uses l3-network, MANY2MANY)
  • +
  • FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
  • +
  • FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
  • +
  • FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
  • +
  • FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
  • +
  • FROM pnf( pnf LocatedIn complex, MANY2ONE)
  • +
  • FROM pserver( pserver LocatedIn complex, MANY2ONE)
  • +
  • FROM vce( vce LocatedIn complex, MANY2MANY)
  • +
  • FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
  • +
  • FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
  • +
  • FROM zone( zone LocatedIn complex, MANY2ONE)
  • +

    +
  • (1) IF this COMPLEX node is deleted, this FROM node is DELETED also
  • +
  • COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
  • @@ -153612,13 +131822,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Port Mirror Configuration.

      -
    • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • -
    • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • -
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • -
    • CONFIGURATION is DELETED when these are DELETED METADATUM
    • -
    • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    +
  • TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
  • +
  • TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
  • +
  • FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
  • +
  • FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
  • +
  • FROM service-instance( service-instance Uses configuration, ONE2MANY)
  • +

    +
  • (1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
  • +
  • (3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
  • @@ -153874,10 +132086,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of resource instances used to connect a variety of disparate inventory widgets

      -
    • TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • -
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • -
    • CONNECTOR is DELETED when these are DELETED METADATUM
    +
  • TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
  • +
  • FROM service-instance( service-instance Uses connector, MANY2MANY)
  • +

    +
  • (1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
  • @@ -154067,10 +132280,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
    • -
    • TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
    • -
    • CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
    +
  • TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
  • +
  • TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
  • +
  • FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
  • +

    +
  • (1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
  • @@ -154217,8 +132432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    +
  • TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
  • +
  • FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
  • @@ -154324,9 +132541,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A collection of C tags (vlan tags) grouped for a specific purpose.

      -
    • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • -
    • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • -
    • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    +
  • TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
  • +
  • TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • +
  • FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this CTAG-POOL is DELETED also
  • @@ -154470,8 +132689,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    customer identifiers to provide linkage back to BSS information.

      -
    • FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • -
    • CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
    +
  • FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
  • +

    +
  • (1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
  • @@ -154726,8 +132946,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    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.

      -
    • TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    +
  • TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
  • +
  • TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • @@ -155106,9 +133326,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
    • -
    • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
    • -
    • ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
    +
  • TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
  • +
  • FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
  • +

    +
  • (1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
  • @@ -155255,8 +133477,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for entitlement group.

      -
    • TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    +
  • TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
  • @@ -155379,8 +133603,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist EMS address information used by EMS driver.

      -
    • TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
    • -
    • ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    +
  • TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
  • +

    +
  • (2) IF this ESR-EMS node is deleted, this TO node is DELETED also
  • @@ -155506,10 +133731,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist common address information of external systems.

      -
    • FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
    • -
    • FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
    • -
    • FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
    • -
    • FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
    +
  • FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
  • +
  • FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
  • +
  • FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
  • +
  • FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
  • +

    +
  • (3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
  • @@ -155838,9 +134065,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
    • +
    • TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
    • TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
    • -
    • ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    +

    +
  • (2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
  • @@ -155990,8 +134218,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist VNFM address information used by VF-C.

      -
    • TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
    • -
    • ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    +
  • TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
  • +

    +
  • (2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
  • @@ -156141,7 +134370,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    evc object is an optional child object of the Configuration object.

      -
    • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    +
  • TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this EVC is DELETED also
  • @@ -156564,9 +134795,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack flavor.

      -
    • TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
    • -
    • FLAVOR cannot be deleted if linked to VSERVER
    +
  • TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vserver( vserver Uses flavor, MANY2ONE)
  • +

    +
  • FLAVOR cannot be deleted if related to VSERVER
  • @@ -156786,12 +135018,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Entity describing a sequenced segment of forwarding path

      -
    • TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
    • -
    • TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
    • -
    • TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
    • -
    • TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
    • -
    • TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
    • -
    • FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
    +
  • TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
  • +
  • TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
  • +
  • TO configuration( forwarder Uses configuration, ONE2ONE)(2)
  • +
  • TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
  • +
  • TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
  • +

    +
  • (2) IF this FORWARDER node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this FORWARDER is DELETED also
  • @@ -156872,7 +135106,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    forwarder object is an optional child object of the Configuration object.

      -
    • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    +
  • TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
  • @@ -157063,11 +135299,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Entity that describes the sequenced forwarding path between interfaces of services or resources

      -
    • TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
    • -
    • TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
    • -
    • FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
    • -
    • FORWARDING-PATH is DELETED when these are DELETED FORWARDER
    • -
    • FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
    +
  • TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
  • +
  • TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
  • +
  • FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
  • +

    +
  • (1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
  • @@ -157218,28 +135456,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

      -
    • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • -
    • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • -
    • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • -
    • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • -
    • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • -
    • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • -
    • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • -
    • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • -
    • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • -
    • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • -
    • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
    +
  • TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
  • +
  • TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
  • +
  • TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • +
  • TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
  • +
  • TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
  • +
  • TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
  • +
  • TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
  • +
  • TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
  • +
  • TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
  • +
  • TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
  • +
  • FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
  • +
  • FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
  • +
  • FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
  • +

    +
  • (1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
  • @@ -157544,6 +135783,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    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.

    @@ -157556,6 +135796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether closed loop function is enabled on this node

    @@ -157979,9 +136220,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

      -
    • TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
    • -
    • FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
    +
  • TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
  • +
  • FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
  • @@ -158128,7 +136369,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
    +
  • TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
  • @@ -158313,10 +136556,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents a HPA capability

      -
    • TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
    • -
    • TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
    • -
    • HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
    +
  • TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
  • +
  • TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
  • +

    +
  • (1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
  • @@ -158442,7 +136686,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    HPA Capability Feature attributes

      -
    • TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
    +
  • TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
  • @@ -158523,11 +136769,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

      -
    • TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • -
    • FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
    • -
    • IMAGE cannot be deleted if linked to VSERVER
    • -
    • IMAGE is DELETED when these are DELETED METADATUM
    +
  • TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
  • +
  • FROM vserver( vserver Uses image, MANY2ONE)
  • +

    +
  • (1) IF this IMAGE node is deleted, this FROM node is DELETED also
  • +
  • IMAGE cannot be deleted if related to VSERVER
  • @@ -158847,14 +137094,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General mechanism for grouping instances

      -
    • TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
    • -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • -
    • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • -
    • FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    +
  • TO model( instance-group Targets model, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • +
  • FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
  • +
  • FROM pnf( pnf MemberOf instance-group, MANY2MANY)
  • +
  • FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
  • @@ -159121,29 +137368,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - aai-internal: - object - - -
    -
    - -
    - -
    - aai-internal - - - -
    - -
    -
    -
    nodes: - object[] + object
    @@ -159152,7 +137379,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - aai-internal + nodes @@ -159410,9 +137637,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    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

      -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • -
    • FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    • -
    • IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
    +
  • FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • +
  • FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
  • +

    +
  • (1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
  • @@ -159817,21 +138045,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

      -
    • TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • -
    • TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • -
    • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • -
    • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • -
    • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • -
    • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • -
    • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • -
    • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • -
    • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    +
  • TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
  • +
  • TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
  • +
  • TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
  • +
  • TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
  • +
  • TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
  • +
  • TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
  • +
  • TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
  • +
  • FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
  • +
  • FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
  • +
  • FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
  • +

    +
  • (1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this L-INTERFACE is DELETED also
  • @@ -159954,6 +138184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    boolean indicatating whether or not port is a mirrored.

    @@ -159978,6 +138209,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

    @@ -160161,11 +138393,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • -
    • TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • -
    • TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • -
    • TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    +
  • TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • +
  • TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • +
  • TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
  • +
  • TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
  • @@ -160306,11 +138540,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • -
    • TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • -
    • TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • -
    • TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • -
    • TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    +
  • TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • +
  • TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • +
  • TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • +
  • TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
  • +
  • TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
  • @@ -160451,22 +138687,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

      -
    • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • -
    • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • -
    • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • -
    • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • -
    • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • -
    • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • -
    • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • -
    • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • -
    • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • -
    • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
    +
  • TO network-policy( l3-network Uses network-policy, MANY2MANY)
  • +
  • TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
  • +
  • TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
  • +
  • FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
  • +
  • FROM complex( complex Uses l3-network, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • +
  • FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
  • +
  • FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
  • +
  • FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
  • +
  • FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
  • +
  • FROM tenant( tenant Uses l3-network, MANY2MANY)
  • +
  • FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
  • +

    +
  • (1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
  • @@ -160554,6 +138791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Set to true if bound to VPN

    @@ -160734,6 +138972,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    boolean indicatating whether or not network is a provider network.

    @@ -160746,6 +138985,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    boolean indicatating whether or not network is a shared network.

    @@ -160758,6 +138998,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    boolean indicatating whether or not network is an external network.

    @@ -160921,16 +139162,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Link aggregate interface

      -
    • TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • -
    • TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • -
    • TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • -
    • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • -
    • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • -
    • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • -
    • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • -
    • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • -
    • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
    +
  • TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
  • +
  • TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
  • +
  • TO p-interface( lag-interface Uses p-interface, MANY2MANY)
  • +
  • TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
  • +
  • TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
  • +
  • TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
  • +
  • FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
  • +

    +
  • (1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
  • @@ -161041,6 +139284,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

    @@ -161144,8 +139388,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    LAG links can connect lag-interfaces

      -
    • FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    +
  • FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
  • +
  • FROM logical-link( logical-link Uses lag-link, MANY2MANY)
  • +

    +
  • (3) IF this FROM node is deleted, this LAG-LINK is DELETED also
  • @@ -161255,8 +139501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for license group.

      -
    • TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    +
  • TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO vce( license BelongsTo vce, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this LICENSE is DELETED also
  • @@ -161379,7 +139627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a line-of-business

      -
    • TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    +
  • TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
  • @@ -161489,20 +139737,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical links generally connect l-interfaces but are used to express logical connectivity between two points

      -
    • TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • -
    • TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • -
    • TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    • -
    • TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • -
    • TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • -
    • TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • -
    • TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • -
    • TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • -
    • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • -
    • FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • -
    • FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • -
    • FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    +
  • TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
  • +
  • TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
  • +
  • TO lag-link( logical-link Uses lag-link, MANY2MANY)
  • +
  • TO logical-link( logical-link Uses logical-link, MANY2MANY)
  • +
  • TO pnf( logical-link BridgedTo pnf, MANY2MANY)
  • +
  • TO pserver( logical-link BridgedTo pserver, MANY2MANY)
  • +
  • TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
  • +
  • TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
  • +
  • FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
  • +
  • FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
  • +
  • FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
  • +
  • FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
  • +
  • FROM logical-link( logical-link Uses logical-link, MANY2MANY)
  • +

    +
  • (3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
  • @@ -161858,10 +140108,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Key/value pairs

      -
    • TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • -
    • TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • -
    • TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • -
    • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    +
  • TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
  • +
  • TO image( metadatum BelongsTo image, MANY2ONE)(4)
  • +
  • TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
  • +
  • TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this METADATUM is DELETED also
  • @@ -161921,13 +140173,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

      -
    • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • -
    • FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
    • -
    • FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • -
    • FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
    • -
    • FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
    • -
    • MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
    • -
    • MODEL is DELETED when these are DELETED MODEL-VER
    +
  • TO model( model-ver BelongsTo model, MANY2ONE)(1)
  • +
  • FROM instance-group( instance-group Targets model, MANY2MANY)
  • +
  • FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
  • +
  • FROM named-query( named-query AppliesTo model, ONE2MANY)
  • +
  • FROM named-query-element( named-query-element IsA model, MANY2ONE)
  • +

    +
  • (1) IF this MODEL node is deleted, this FROM node is DELETED also
  • +
  • MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
  • @@ -162132,9 +140385,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
    • -
    • MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
    +
  • TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
  • +
  • FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
  • +

    +
  • (1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
  • @@ -162251,14 +140506,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Defines how other models combine to make up a higher-level model.

      -
    • TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
    • -
    • TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • -
    • TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • -
    • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • -
    • MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
    +
  • TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
  • +
  • TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
  • +
  • TO model-ver( model-element IsA model-ver, MANY2ONE)
  • +
  • TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
  • +
  • FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
  • +
  • FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
  • +
  • FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
  • +

    +
  • (1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
  • @@ -162440,12 +140697,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

      -
    • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • -
    • FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • -
    • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • -
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • -
    • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
    • -
    • MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
    +
  • TO model( model-ver BelongsTo model, MANY2ONE)(4)
  • +
  • FROM model-element( model-element IsA model-ver, MANY2ONE)
  • +
  • FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
  • +
  • FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
  • +

    +
  • (1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this MODEL-VER is DELETED also
  • +
  • MODEL-VER cannot be deleted if related to MODEL-ELEMENT
  • @@ -162669,7 +140928,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    +
  • FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
  • @@ -162842,10 +141101,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • -
    • TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
    • -
    • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • -
    • NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
    +
  • TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
  • +
  • TO model( named-query AppliesTo model, ONE2MANY)
  • +
  • FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
  • +

    +
  • (1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
  • @@ -162978,13 +141238,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • -
    • TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
    • -
    • TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • -
    • FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • -
    • FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • -
    • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • -
    • NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
    +
  • TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
  • +
  • TO model( named-query-element IsA model, MANY2ONE)
  • +
  • TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • +
  • FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
  • +
  • FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
  • +
  • FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • +

    +
  • (1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
  • @@ -163598,8 +141860,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
    • -
    • FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    +
  • FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
  • +
  • FROM l3-network( l3-network Uses network-policy, MANY2MANY)
  • @@ -163692,7 +141954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Network profile populated by SDN-GP for SNMP

      -
    • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    +
  • TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
  • @@ -163814,8 +142076,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

      -
    • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • -
    • NEWVCE is DELETED when these are DELETED L-INTERFACE
    +
  • FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
  • +

    +
  • (1) IF this NEWVCE node is deleted, this FROM node is DELETED also
  • @@ -164077,6 +142340,43 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    nodes: + object + + + +

    +
    +
    + +
    +
    +
    + inventory-item-data: + object[] + + +
    +
    + +
    + +
    + inventory-item-data + + + +
    + +
    +
    +
    +
    +
    +
    +

    notification-event: @@ -164381,9 +142681,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    OAM network, to be deprecated shortly. Do not use for new purposes.

      -
    • TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • -
    • TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    +
  • TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
  • +
  • TO complex( oam-network AppliesTo complex, MANY2MANY)
  • +
  • TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
  • @@ -164543,8 +142843,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

      -
    • TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
    • -
    • FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
    +
  • TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
  • +
  • FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
  • @@ -164923,7 +143223,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes an owning-entity

      -
    • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
    +
  • FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
  • @@ -165005,15 +143305,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Physical interface (e.g., nic)

      -
    • TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • -
    • TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • -
    • TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • -
    • TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • -
    • TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • -
    • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • -
    • FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • -
    • P-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • -
    • P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
    +
  • TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
  • +
  • TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
  • +
  • TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
  • +
  • TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
  • +
  • TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
  • +
  • FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
  • +
  • FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
  • +

    +
  • (1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this P-INTERFACE is DELETED also
  • @@ -165136,6 +143438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

    @@ -165239,7 +143542,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical connections, typically between p-interfaces

      -
    • FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    +
  • FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
  • +

    +
  • (3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
  • @@ -165421,7 +143726,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a platform

      -
    • TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    +
  • TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
  • @@ -165531,14 +143836,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    PNF represents a physical network function. typically equipment used in the D1 world.

      -
    • TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • -
    • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • -
    • FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • -
    • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    +
  • TO complex( pnf LocatedIn complex, MANY2ONE)
  • +
  • TO instance-group( pnf MemberOf instance-group, MANY2MANY)
  • +
  • TO zone( pnf LocatedIn zone, MANY2ONE)
  • +
  • FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
  • +
  • FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
  • +
  • FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
  • +

    +
  • (1) IF this PNF node is deleted, this FROM node is DELETED also
  • @@ -165673,6 +143979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    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.

    @@ -165928,9 +144235,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Used to capture the network interfaces of this VCE

      -
    • TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • -
    • FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
    • -
    • PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
    +
  • TO vce( port-group BelongsTo vce, MANY2ONE)(4)
  • +
  • FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
  • +

    +
  • (1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this PORT-GROUP is DELETED also
  • @@ -166165,7 +144474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes the project

      -
    • TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
    +
  • TO service-instance( project Uses service-instance, ONE2MANY)
  • @@ -166318,7 +144627,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    +
  • TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
  • @@ -166438,19 +144749,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

      -
    • TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
    • -
    • TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
    • -
    • TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • -
    • TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • -
    • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • -
    • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • -
    • FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • -
    • FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
    • -
    • PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
    • -
    • PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • -
    • PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
    +
  • TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
  • +
  • TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
  • +
  • TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
  • +
  • TO complex( pserver LocatedIn complex, MANY2ONE)
  • +
  • TO zone( pserver LocatedIn zone, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
  • +
  • FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
  • +
  • FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
  • +
  • FROM vserver( vserver HostedOn pserver, MANY2ONE)
  • +

    +
  • (1) IF this PSERVER node is deleted, this FROM node is DELETED also
  • +
  • PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
  • @@ -166705,6 +145016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    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.

    @@ -166937,7 +145249,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    +
  • TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
  • @@ -167462,7 +145776,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack route table reference.

      -
    • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    +
  • FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
  • @@ -167585,7 +145899,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Route target information

      -
    • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    +
  • TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
  • @@ -167707,9 +146023,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
    • -
    • FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
    • -
    • ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
    +
  • TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
  • +
  • FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
  • +

    +
  • (1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
  • @@ -168154,7 +146472,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack segmentation assignment.

      -
    • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    +
  • TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
  • @@ -168408,9 +146728,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

      -
    • FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • -
    • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • -
    • SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
    +
  • FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
  • +
  • FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
  • +

    +
  • SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
  • @@ -168613,24 +146934,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Instance of a service

      -
    • TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • -
    • TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • -
    • TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • -
    • TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • -
    • TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    • -
    • TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
    • -
    • TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • -
    • TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • -
    • TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • -
    • TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • -
    • TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • -
    • TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • -
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • -
    • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
    • -
    • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    +
  • TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
  • +
  • TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
  • +
  • TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
  • +
  • TO connector( service-instance Uses connector, MANY2MANY)
  • +
  • TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
  • +
  • TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
  • +
  • TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
  • +
  • TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
  • +
  • TO pnf( service-instance ComposedOf pnf, ONE2MANY)
  • +
  • TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
  • +
  • TO vlan( service-instance ComposedOf vlan, ONE2MANY)
  • +
  • TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
  • +
  • TO vce( service-instance ComposedOf vce, ONE2MANY)
  • +
  • FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
  • +
  • FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
  • +
  • FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
  • +

    +
  • (1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
  • @@ -168960,10 +147283,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Object that group service instances.

      -
    • TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • -
    • TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • -
    • SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
    +
  • TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
  • +
  • TO tenant( service-subscription Uses tenant, MANY2MANY)
  • +
  • FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
  • +

    +
  • (1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
  • @@ -169145,9 +147470,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
    • -
    • FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
    • -
    • SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
    +
  • TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
  • +
  • FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
  • +

    +
  • (1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
  • +
  • (4) IF this TO node is deleted, this SITE-PAIR is DELETED also
  • @@ -169296,9 +147623,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Set of instances for probes used to measure service level agreements

      -
    • TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • -
    • FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
    • -
    • SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
    +
  • TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • +
  • FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
  • +

    +
  • (1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
  • @@ -169469,8 +147797,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack snapshot

      -
    • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    +
  • TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
  • +
  • FROM vserver( vserver Uses snapshot, ONE2ONE)
  • @@ -169688,8 +148016,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Physical Function

      -
    • TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
    • -
    • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
    +
  • TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
  • +
  • FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
  • +

    +
  • (4) IF this TO node is deleted, this SRIOV-PF is DELETED also
  • @@ -169799,7 +148129,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Virtual Function (not to be confused with virtual network function)

      -
    • TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    +
  • TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this SRIOV-VF is DELETED also
  • @@ -170091,10 +148423,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • -
    • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • -
    • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • -
    • SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
    +
  • TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this SUBNET is DELETED also
  • +
  • SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
  • @@ -170205,6 +148539,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    dhcp enabled

    @@ -170357,13 +148692,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack tenant

      -
    • TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
    • -
    • TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • -
    • TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • -
    • FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
    • -
    • FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
    • -
    • TENANT cannot be deleted if linked to VSERVER
    +
  • TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
  • +
  • TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
  • +
  • TO l3-network( tenant Uses l3-network, MANY2MANY)
  • +
  • TO volume-group( tenant DependsOn volume-group, ONE2MANY)
  • +
  • FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
  • +
  • FROM vserver( vserver BelongsTo tenant, MANY2ONE)
  • +

    +
  • TENANT cannot be deleted if related to VSERVER
  • @@ -170506,7 +148842,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

      -
    • TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    +
  • TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
  • @@ -170791,14 +149129,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

      -
    • TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • -
    • TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • -
    • TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • -
    • FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • -
    • FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • -
    • VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
    +
  • TO availability-zone( vce Uses availability-zone, MANY2MANY)
  • +
  • TO complex( vce LocatedIn complex, MANY2MANY)
  • +
  • TO vserver( vce HostedOn vserver, ONE2MANY)
  • +
  • FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
  • +
  • FROM license( license BelongsTo vce, MANY2ONE)(1)
  • +
  • FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
  • +
  • FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
  • +

    +
  • (1) IF this VCE node is deleted, this FROM node is DELETED also
  • @@ -171174,12 +149513,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    a deployment unit of VNFCs

      -
    • TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • -
    • TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • -
    • TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • -
    • TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • -
    • VF-MODULE cannot be deleted if linked to VNFC
    +
  • TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
  • +
  • TO vnfc( vf-module Uses vnfc, ONE2MANY)
  • +
  • TO volume-group( vf-module Uses volume-group, ONE2ONE)
  • +
  • TO vserver( vf-module Uses vserver, ONE2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this VF-MODULE is DELETED also
  • +
  • VF-MODULE cannot be deleted if related to VNFC
  • @@ -171242,6 +149583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is base vf module

    @@ -171445,7 +149787,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

      -
    • TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    +
  • TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
  • +

    +
  • (4) IF this TO node is deleted, this VIG-SERVER is DELETED also
  • @@ -171575,10 +149919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • -
    • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
    +
  • TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • +
  • TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • +
  • TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • +
  • FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
  • @@ -171719,10 +150063,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • -
    • TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • -
    • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
    +
  • TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • +
  • TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • +
  • TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
  • +
  • FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
  • @@ -171863,9 +150207,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual organization of cloud infrastructure elements in a data center context

      -
    • FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    +
  • FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • +
  • FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
  • @@ -171988,15 +150332,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Definition of vlan

      -
    • TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • -
    • TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • -
    • TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    • -
    • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
    • -
    • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • -
    • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • -
    • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • -
    • VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
    • -
    • VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    +
  • TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
  • +
  • TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
  • +
  • TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
  • +
  • FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
  • +
  • FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
  • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
  • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
  • +

    +
  • (1) IF this VLAN node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this VLAN node is deleted, this TO node is DELETED also
  • +
  • (4) IF this TO node is deleted, this VLAN is DELETED also
  • @@ -172131,6 +150477,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

    @@ -172284,8 +150631,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

      -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • -
    • VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
    +
  • FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
  • +

    +
  • VNF-IMAGE cannot be deleted if related to GENERIC-VNF
  • @@ -172444,9 +150792,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • -
    • TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    +
  • TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
  • +
  • TO vserver( vnfc HostedOn vserver, ONE2MANY)
  • +
  • FROM vf-module( vf-module Uses vnfc, ONE2MANY)
  • +

    +
  • (4) IF this TO node is deleted, this VNFC is DELETED also
  • @@ -172535,6 +150885,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

    @@ -172547,6 +150898,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    used to indicate whether closed loop function is enabled on this node

    @@ -172654,7 +151006,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Ephemeral Block storage volume.

      -
    • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
    +
  • FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
  • +

    +
  • (3) IF this FROM node is deleted, this VOLUME is DELETED also
  • @@ -172736,11 +151090,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persistent block-level storage.

      -
    • TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • -
    • TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • -
    • FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • -
    • FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    +
  • TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
  • +
  • TO complex( volume-group LocatedIn complex, MANY2ONE)
  • +
  • FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
  • +
  • FROM vf-module( vf-module Uses volume-group, ONE2ONE)
  • +
  • FROM tenant( tenant DependsOn volume-group, ONE2MANY)
  • @@ -172965,11 +151319,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPLS Provider Edge routers.

      -
    • TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • -
    • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • -
    • FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • -
    • VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    +
  • TO complex( vpls-pe LocatedIn complex, MANY2ONE)
  • +
  • TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
  • +
  • FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
  • +
  • FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
  • +

    +
  • (1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
  • @@ -173166,11 +151521,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPN binding

      -
    • FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • -
    • FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • -
    • FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • -
    • VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
    • -
    • VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
    +
  • FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
  • +
  • FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
  • +
  • FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
  • +

    +
  • (1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
  • +
  • VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
  • @@ -173345,19 +151701,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Servers, aka virtual machine or VM.

      -
    • TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
    • -
    • TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
    • -
    • TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
    • -
    • TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
    • -
    • TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    • -
    • TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
    • -
    • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • -
    • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • -
    • FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • -
    • VSERVER is DELETED when these are DELETED L-INTERFACE
    • -
    • VSERVER deletion means associated objects of these types are also DELETED:VOLUME
    +
  • TO tenant( vserver BelongsTo tenant, MANY2ONE)
  • +
  • TO flavor( vserver Uses flavor, MANY2ONE)
  • +
  • TO image( vserver Uses image, MANY2ONE)
  • +
  • TO pserver( vserver HostedOn pserver, MANY2ONE)
  • +
  • TO snapshot( vserver Uses snapshot, ONE2ONE)
  • +
  • TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
  • +
  • FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
  • +
  • FROM vce( vce HostedOn vserver, ONE2MANY)
  • +
  • FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
  • +
  • FROM vf-module( vf-module Uses vserver, ONE2MANY)
  • +
  • FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
  • +

    +
  • (1) IF this VSERVER node is deleted, this FROM node is DELETED also
  • +
  • (2) IF this VSERVER node is deleted, this TO node is DELETED also
  • @@ -173434,6 +151791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    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.

    @@ -173446,6 +151804,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used to indicate whether closed loop function is enabled on this node

    @@ -173581,10 +151940,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A zone is a grouping of assets in a location homing to the same connections into the CBB

      -
    • TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • -
    • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • -
    • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • -
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    +
  • TO complex( zone LocatedIn complex, MANY2ONE)
  • +
  • FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
  • +
  • FROM pnf( pnf LocatedIn zone, MANY2ONE)
  • +
  • FROM pserver( pserver LocatedIn zone, MANY2ONE)
  • diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html index e2e7b36b..d5741ec8 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html @@ -5599,70 +5599,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns connectors

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns connector
    -

    GET /business/connectors/connector/{resource-instance-id}

    - Tags: - Business -
    -
    -
    -

    returns connector

    -
    @@ -5681,15 +5617,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen resource-instance-id - + @@ -5697,7 +5631,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Unique id of resource instance.

    pathquery string -
    -

    the ASDC model id for this resource or service model.

    query @@ -5712,7 +5645,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

    the ASDC model version for this resource or service model.

    query @@ -5727,7 +5659,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -5742,7 +5673,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query @@ -5778,7 +5708,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -5791,7 +5721,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -5807,35 +5737,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing connector
    -

    PUT /business/connectors/connector/{resource-instance-id}

    +
    returns connector
    +

    GET /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    create or update an existing connector

    +

    returns connector

    -
    - -

    application/json application/xml -

    -
    -
    -

    connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -5873,6 +5786,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    default @@ -5880,7 +5816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -5896,16 +5832,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing connector
    -

    PATCH /business/connectors/connector/{resource-instance-id}

    +
    create or update an existing connector
    +

    PUT /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    update an existing connector

    +

    create or update an existing connector

    @@ -5914,13 +5850,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    connector object that needs to be created or updated.

    +

    connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

    @@ -5969,7 +5905,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -5985,22 +5921,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing connector
    -

    DELETE /business/connectors/connector/{resource-instance-id}

    +
    update an existing connector
    +

    PATCH /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    delete an existing connector

    +

    update an existing connector

    application/json application/xml

    +
    +
    +

    connector object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    @@ -6030,22 +5978,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -6062,7 +5994,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6077,19 +6009,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /business/connectors/connector/{resource-instance-id}/metadata

    +
    delete an existing connector
    +

    DELETE /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    returns metadata

    +

    delete an existing connector

    +
    + +

    application/json application/xml +

    +
    @@ -6120,55 +6057,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -6187,29 +6080,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -6217,7 +6087,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6232,17 +6102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadatum
    -

    GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

    +
    returns metadata
    +

    GET /business/connectors/connector/{resource-instance-id}/metadata

    Tags: Business
    -

    returns metadatum

    +

    returns metadata

    @@ -6278,37 +6148,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen metaname
    - - - - - - - - - - - - - - + +
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version + resource-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    resource-version for concurrency

    query @@ -6176,6 +6068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - path - string - - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    query @@ -6318,34 +6157,114 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /metadata +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns metadatum
    +

    GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

    + Tags: + Business +
    +
    +
    +

    returns metadatum

    + +
    +
    + + + + + + + + + + + - + - + @@ -6387,7 +6306,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6491,7 +6410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6525,7 +6444,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated.

    +

    metadatum object that needs to be updated.

    @@ -6595,7 +6514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6703,7 +6622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6792,7 +6711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6869,7 +6788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -6896,70 +6815,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns customers

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    - - - - -
    -
    -
    returns customer
    -

    GET /business/customers/customer/{global-customer-id}

    - Tags: - Business -
    -
    -
    -

    returns customer

    -
    - widget-model-id + resource-instance-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Unique id of resource instance.

    querypath string +
    - widget-model-version + metaname -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    querypath string +
    @@ -6978,15 +6833,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen global-customer-id - + @@ -6994,7 +6847,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-name - - - - - - - - - - - - - - - - - - - - -
    -

    Global customer id used across ECOMP to uniquely identify customer.

    pathquery string -
    -

    Subscriber name, an alternate way to retrieve a customer.

    query @@ -7009,7 +6861,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-type -

    Subscriber type, a way to provide VID with only the INFRA customers.

    query @@ -7045,7 +6896,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -7058,7 +6909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7074,35 +6925,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing customer
    -

    PUT /business/customers/customer/{global-customer-id}

    +
    returns customer
    +

    GET /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    create or update an existing customer

    +

    returns customer

    -
    - -

    application/json application/xml -

    -
    -
    -

    customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

    -

    -
    -
    -
    -
    - /customer -
    -
    -
    -
    @@ -7140,6 +6974,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /customer +
    +
    +
    + +
    default @@ -7147,7 +7004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7163,16 +7020,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing customer
    -

    PATCH /business/customers/customer/{global-customer-id}

    +
    create or update an existing customer
    +

    PUT /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    update an existing customer

    +

    create or update an existing customer

    @@ -7181,13 +7038,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    customer object that needs to be created or updated.

    +

    customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

    @@ -7236,7 +7093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7252,16 +7109,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing customer
    -

    DELETE /business/customers/customer/{global-customer-id}

    +
    update an existing customer
    +

    PATCH /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    delete an existing customer

    +

    update an existing customer

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    customer object that needs to be updated.

    +

    +
    +
    +
    +
    + /customer +
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
    + global-customer-id + +

    Global customer id used across ECOMP to uniquely identify customer.

    +
    path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing customer
    +

    DELETE /business/customers/customer/{global-customer-id}

    + Tags: + Business +
    +
    +
    +

    delete an existing customer

    @@ -7329,7 +7275,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7418,7 +7364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7495,7 +7441,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7553,25 +7499,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type + service-type -

    Subscriber type, a way to provide VID with only the INFRA customers.

    query @@ -7620,7 +7550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7692,36 +7622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    @@ -7761,7 +7661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7866,7 +7766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -7900,7 +7800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-subscription object that needs to be created or updated.

    +

    service-subscription object that needs to be updated.

    @@ -7971,7 +7871,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8080,7 +7980,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8185,7 +8085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8278,7 +8178,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8305,147 +8205,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns service-instances

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - global-customer-id - -

    Global customer id used across ECOMP to uniquely identify customer.

    -
    path - string - - - -
    - service-type - -

    Value defined by orchestration to identify this service across ECOMP.

    -
    path - string - - - -
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    - - - - -
    -
    -
    returns service-instance
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

    - Tags: - Business -
    -
    -
    -

    returns service-instance

    -
    @@ -8496,23 +8255,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-instance-id - + + +
    -

    Uniquely identifies this instance of a service

    pathquery string -
    - subscriber-name + service-instance-name -

    Subscriber name, an alternate way to retrieve a customer.

    query @@ -8524,10 +8280,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-type + environment-context -

    Subscriber type, a way to provide VID with only the INFRA customers.

    query @@ -8539,10 +8294,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-instance-name + workload-context -

    This field will store a name assigned to the service-instance.

    query @@ -8554,10 +8308,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - environment-context + model-invariant-id -

    This field will store the environment context assigned to the service-instance.

    query @@ -8569,10 +8322,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - workload-context + model-version-id -

    This field will store the workload context assigned to the service-instance.

    query @@ -8584,10 +8336,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + widget-model-id -

    the ASDC model id for this resource or service model.

    query @@ -8599,10 +8350,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + widget-model-version -

    the ASDC model version for this resource or service model.

    query @@ -8614,10 +8364,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + service-instance-location-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -8629,10 +8378,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + orchestration-status -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query @@ -8642,34 +8390,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns service-instance
    +

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

    + Tags: + Business +
    +
    +
    +

    returns service-instance

    + +
    +
    + + + + + + + + + + + + + + + + + + - + - + @@ -8711,7 +8556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8832,7 +8677,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -8866,7 +8711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-instance object that needs to be created or updated.

    +

    service-instance object that needs to be updated.

    @@ -8953,7 +8798,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -9078,7 +8923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -9168,40 +9013,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - + +
    + global-customer-id + +

    Global customer id used across ECOMP to uniquely identify customer.

    +
    path + string + + + +
    - service-instance-location-id + service-type -

    An identifier that customers assign to the location where this service is being used.

    +

    Value defined by orchestration to identify this service across ECOMP.

    querypath string +
    - orchestration-status + service-instance-id -

    Orchestration status of this service.

    +

    Uniquely identifies this instance of a service

    querypath string +
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name + id -

    This field will store a name assigned to the service-instance.

    query @@ -9213,10 +9027,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - environment-context + model-invariant-id -

    This field will store the environment context assigned to the service-instance.

    query @@ -9228,10 +9041,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - workload-context + model-version-id -

    This field will store the workload context assigned to the service-instance.

    query @@ -9243,10 +9055,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + type -

    the ASDC model id for this resource or service model.

    query @@ -9258,10 +9069,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + role -

    the ASDC model version for this resource or service model.

    query @@ -9271,432 +9081,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    + +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns allotted-resource
    +

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

    + Tags: + Business +
    +
    +
    +

    returns allotted-resource

    + +
    +
    + + + + + + + + + + + - + - + - + - - - - - -
    - widget-model-id + global-customer-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Global customer id used across ECOMP to uniquely identify customer.

    querypath string +
    - widget-model-version + service-type -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Value defined by orchestration to identify this service across ECOMP.

    querypath string +
    - service-instance-location-id + service-instance-id -

    An identifier that customers assign to the location where this service is being used.

    +

    Uniquely identifies this instance of a service

    querypath string +
    - orchestration-status + id -

    Orchestration status of this service.

    +

    Allotted Resource id UUID assigned to this instance.

    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    - -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns allotted-resource
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

    - Tags: - Business -
    -
    -
    -

    returns allotted-resource

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -9738,7 +9263,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -9875,7 +9400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -9909,7 +9434,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    allotted-resource object that needs to be created or updated.

    +

    allotted-resource object that needs to be updated.

    @@ -10012,7 +9537,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -10153,7 +9678,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -10290,7 +9815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -10415,7 +9940,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -10521,220 +10046,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - global-customer-id - -

    Global customer id used across ECOMP to uniquely identify customer.

    -
    path - string - - - -
    - service-type - -

    Value defined by orchestration to identify this service across ECOMP.

    -
    path - string - - - -
    - service-instance-id - -

    Uniquely identifies this instance of a service

    -
    path - string - - - -
    - id - -

    Allotted Resource id UUID assigned to this instance.

    -
    path - string - - - -
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -
    query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -
    query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - service-instance-location-id - -

    An identifier that customers assign to the location where this service is being used.

    -
    query - string - - -
    - orchestration-status - -

    Orchestration status of this service.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - type - -

    Generic description of the type of allotted resource.

    -
    query - string - - -
    - role - -

    role in the network that this resource will be providing.

    -
    querypath string +
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -
    query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -
    query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - service-instance-location-id - -

    An identifier that customers assign to the location where this service is being used.

    -
    query - string - - -
    - orchestration-status - -

    Orchestration status of this service.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - type - -

    Generic description of the type of allotted resource.

    -
    query - string - - -
    - role + id -

    role in the network that this resource will be providing.

    query @@ -10783,7 +10097,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -10903,231 +10217,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -
    query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -
    query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - service-instance-location-id - -

    An identifier that customers assign to the location where this service is being used.

    -
    query - string - - -
    - orchestration-status - -

    Orchestration status of this service.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - type - -

    Generic description of the type of allotted resource.

    -
    query - string - - -
    - role - -

    role in the network that this resource will be providing.

    -
    query - string - - -
    @@ -11167,7 +10256,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -11320,7 +10409,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -11354,7 +10443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tunnel-xconnect object that needs to be created or updated.

    +

    tunnel-xconnect object that needs to be updated.

    @@ -11473,7 +10562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -11630,7 +10719,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -11783,7 +10872,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -11924,7 +11013,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -12014,160 +11103,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -
    query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -
    query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - service-instance-location-id - -

    An identifier that customers assign to the location where this service is being used.

    -
    query - string - - -
    - orchestration-status + metaname -

    Orchestration status of this service.

    query @@ -12216,7 +11154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -12319,171 +11257,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -
    query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -
    query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -
    query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -
    query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - service-instance-location-id - -

    An identifier that customers assign to the location where this service is being used.

    -
    query - string - - -
    - orchestration-status - -

    Orchestration status of this service.

    -
    query - string - - -
    @@ -12523,7 +11296,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -12659,7 +11432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -12693,7 +11466,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated.

    +

    metadatum object that needs to be updated.

    @@ -12795,7 +11568,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -12935,7 +11708,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13056,7 +11829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13165,7 +11938,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13193,6 +11966,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns lines-of-business

    +
    + + + + + + + + + + + + + + + + + + + +
    + line-of-business-name + + query + string + + +
    +

    application/json application/xml @@ -13229,7 +12031,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13324,7 +12126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13413,7 +12215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13447,7 +12249,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

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

    +

    line-of-business object that needs to be updated.

    @@ -13502,7 +12304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13595,7 +12397,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13684,7 +12486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13761,7 +12563,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13789,6 +12591,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns owning-entities

    +
    + + + + + + + + + + + + + + + + + + + +
    + owning-entity-id + + query + string + + +
    +

    application/json application/xml @@ -13825,7 +12656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -13920,7 +12751,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14009,7 +12840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14043,7 +12874,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    owning-entity object that needs to be created or updated.

    +

    owning-entity object that needs to be updated.

    @@ -14098,7 +12929,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14191,7 +13022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14280,7 +13111,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14357,7 +13188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14385,6 +13216,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns platforms

    +
    + + + + + + + + + + + + + + + + + + + +
    + platform-name + + query + string + + +
    +

    application/json application/xml @@ -14421,7 +13281,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14516,7 +13376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14605,7 +13465,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14639,7 +13499,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    platform object that needs to be created or updated.

    +

    platform object that needs to be updated.

    @@ -14694,7 +13554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14787,7 +13647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14876,7 +13736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14953,7 +13813,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -14981,6 +13841,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns projects

    +
    + + + + + + + + + + + + + + + + + + + +
    + project-name + + query + string + + +
    +

    application/json application/xml @@ -15017,7 +13906,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15112,7 +14001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15201,7 +14090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15235,7 +14124,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    project object that needs to be created or updated.

    +

    project object that needs to be updated.

    @@ -15290,7 +14179,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15383,7 +14272,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15472,7 +14361,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15549,7 +14438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15577,6 +14466,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns cloud-regions

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + + query + string + + +
    + cloud-region-id + + query + string + + +
    + cloud-type + + query + string + + +
    + owner-defined-type + + query + string + + +
    +

    application/json application/xml @@ -15613,7 +14573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15685,36 +14645,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - -
    @@ -15754,7 +14684,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15859,7 +14789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -15893,7 +14823,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cloud-region object that needs to be created or updated.

    +

    cloud-region object that needs to be updated.

    @@ -15964,7 +14894,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16073,7 +15003,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16147,25 +15077,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type + availability-zone-name -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -16214,7 +15128,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16302,36 +15216,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - @@ -16371,7 +15255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16492,7 +15376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16526,7 +15410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    availability-zone object that needs to be created or updated.

    +

    availability-zone object that needs to be updated.

    @@ -16613,7 +15497,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16738,7 +15622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16859,7 +15743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -16968,7 +15852,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17042,10 +15926,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + switch-name -

    Type of the cloud (e.g., openstack)

    query @@ -17057,10 +15940,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + vcenter-url -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -17109,7 +15991,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17197,51 +16079,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - - - - vcenter-url - - -

    URL used to reach the vcenter

    - - query - - string - - - - - @@ -17281,7 +16118,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17402,7 +16239,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17436,7 +16273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    dvs-switch object that needs to be created or updated.

    +

    dvs-switch object that needs to be updated.

    @@ -17523,7 +16360,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17648,7 +16485,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17769,7 +16606,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17878,7 +16715,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -17952,10 +16789,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + esr-system-info-id -

    Type of the cloud (e.g., openstack)

    query @@ -17967,10 +16803,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + system-name + + + + query + + string + + + + + + + + system-type -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -18019,7 +16868,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18107,66 +16956,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - - - - system-name - - -

    name of external system.

    - - query - - string - - - - - - - - system-type - - -

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    - - query - - string - - - - - @@ -18206,7 +16995,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18327,7 +17116,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18361,7 +17150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-system-info object that needs to be created or updated.

    +

    esr-system-info object that needs to be updated.

    @@ -18448,7 +17237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18573,7 +17362,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18694,7 +17483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18803,7 +17592,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18877,32 +17666,157 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type + flavor-id + + + + query + + string + + + + + + + + flavor-name + + + + query + + string + + + + + + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /flavors +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns flavor
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns flavor

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -18931,7 +17845,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -18944,7 +17858,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -18960,18 +17874,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns flavor
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    create or update an existing flavor
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    Tags: CloudInfrastructure
    -

    returns flavor

    +

    create or update an existing flavor

    +
    + +

    application/json application/xml +

    +
    +
    +

    flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    +

    +
    +
    +
    +
    + /flavor +
    +
    +
    +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +
    path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +
    path + string + + + +
    + flavor-id -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Flavor id, expected to be unique across cloud-region.

    querypath string +
    @@ -19032,49 +17963,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing flavor
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    update an existing flavor

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    flavor object that needs to be updated.

    +

    +
    +
    +
    +
    + /flavor +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + @@ -19086,29 +18093,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /flavor -
    -
    -
    - -
    default @@ -19116,7 +18100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -19132,34 +18116,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing flavor
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    delete an existing flavor
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    Tags: CloudInfrastructure
    -

    create or update an existing flavor

    +

    delete an existing flavor

    application/json application/xml

    -
    -
    -

    flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    -

    -
    -
    -
    -
    - /flavor -
    -
    -
    - cloud-type + cloud-owner -

    Type of the cloud (e.g., openstack)

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - owner-defined-type + cloud-region-id -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - flavor-name + flavor-id -

    Flavor name

    +

    Flavor id, expected to be unique across cloud-region.

    querypath string +
    @@ -19221,6 +18193,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -19237,7 +18225,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -19252,17 +18240,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    update an existing flavor
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    update an existing flavor

    +

    see node definition for valid relationships

    @@ -19271,13 +18259,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    flavor object that needs to be created or updated.

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -19358,7 +18346,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -19373,17 +18361,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing flavor
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing flavor

    +

    delete an existing relationship

    @@ -19451,22 +18439,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

    resource-version for concurrency

    - - query - - string - - - - - -
    @@ -19483,7 +18455,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -19498,36 +18470,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    +
    returns group-assignments
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns group-assignments

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -19574,223 +18529,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - flavor-id - -

    Flavor id, expected to be unique across cloud-region.

    -
    path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - flavor-id - -

    Flavor id, expected to be unique across cloud-region.

    -
    path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns group-assignments
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns group-assignments

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id + group-id -

    Identifier used by the vendor for the region. Second part of composite key

    pathquery string -
    - cloud-type + group-type -

    Type of the cloud (e.g., openstack)

    query @@ -19802,10 +18557,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - owner-defined-type + group-name -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -19854,7 +18608,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -19942,66 +18696,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - group-type - -

    Group type - the type of group this instance refers to

    -
    query - string - - -
    - group-name - -

    Group name - name assigned to the group

    -
    query - string - - -
    @@ -20041,7 +18735,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20162,7 +18856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20196,7 +18890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated.

    +

    group-assignment object that needs to be updated.

    @@ -20283,7 +18977,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20408,7 +19102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20529,7 +19223,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20638,7 +19332,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20712,10 +19406,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + image-id -

    Type of the cloud (e.g., openstack)

    query @@ -20727,10 +19420,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + image-name + + + + query + + string + + + + + + + + application + + + + query + + string + + + + + + + + application-vendor + + + + query + + string + + + + + + + + application-version -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -20779,7 +19513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -20867,96 +19601,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - - - - image-name - - -

    Image name

    - - query - - string - - - - - - - - application - - -

    The application that the image instantiates.

    - - query - - string - - - - - - - - application-vendor - - -

    The vendor of the application.

    - - query - - string - - - - - - - - application-version - - -

    The version of the application.

    - - query - - string - - - - - @@ -20996,7 +19640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21117,7 +19761,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21151,7 +19795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    image object that needs to be created or updated.

    +

    image object that needs to be updated.

    @@ -21238,7 +19882,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21363,7 +20007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21453,25 +20097,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type + metaname -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -21481,64 +20109,146 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /metadata +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns metadatum
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns metadatum

    + +
    +
    + + + + + + + + + + + - + - + - + - + @@ -21567,7 +20277,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -21580,7 +20290,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21596,267 +20306,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns metadatum
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    +
    create or update an existing metadatum
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    Tags: CloudInfrastructure
    -

    returns metadatum

    +

    create or update an existing metadatum

    -
    -
    - image-name + cloud-owner -

    Image name

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - application + cloud-region-id -

    The application that the image instantiates.

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - application-vendor + image-id -

    The vendor of the application.

    +

    Image id, expected to be unique across cloud region

    querypath string +
    - application-version + metaname -

    The version of the application.

    querypath string +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - image-id - -

    Image id, expected to be unique across cloud region

    -
    path - string - - - -
    - metaname - - path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - image-name - -

    Image name

    -
    query - string - - -
    - application - -

    The application that the image instantiates.

    -
    query - string - - -
    - application-vendor - -

    The vendor of the application.

    -
    query - string - - -
    - application-version - -

    The version of the application.

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    create or update an existing metadatum
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    create or update an existing metadatum

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

    -

    -
    -
    -
    - -
    -
    -
    +
    + +

    application/json application/xml +

    +
    +
    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

    +

    +
    +
    +
    + +
    +
    +
    @@ -21948,7 +20426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -21982,7 +20460,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated.

    +

    metadatum object that needs to be updated.

    @@ -22084,7 +20562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22224,7 +20702,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22345,7 +20823,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22454,7 +20932,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22528,10 +21006,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + +
    - cloud-type + network-uuid -

    Type of the cloud (e.g., openstack)

    query @@ -22543,10 +21020,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - owner-defined-type + network-name -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -22556,6 +21032,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + + query + integer + + +
    @@ -22595,7 +21085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22683,66 +21173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - - - - network-name - - -

    Name of the network.

    - - query - - string - - - - - - - - cvlan-tag - - -

    cvlan-id

    - - query - - integer - - - - - @@ -22782,7 +21212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22903,7 +21333,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -22937,7 +21367,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    oam-network object that needs to be created or updated.

    +

    oam-network object that needs to be updated.

    @@ -23024,7 +21454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23149,7 +21579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23270,7 +21700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23379,7 +21809,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23484,7 +21914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23577,7 +22007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23604,147 +22034,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns snapshots

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns snapshot
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns snapshot

    -
    @@ -23795,38 +22084,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen snapshot-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -30445,40 +27889,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -23841,7 +22098,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen snapshot-name -

    Snapshot name

    query @@ -23856,7 +22112,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen application -

    The application that the image instantiates.

    query @@ -23871,7 +22126,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen application-vendor -

    The vendor of the application.

    query @@ -23886,7 +22140,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen application-version -

    The version of the application.

    query @@ -23901,7 +22154,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prev-snapshot-id -

    This field contains the UUID of the previous snapshot (if any).

    query @@ -23937,7 +22189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -23950,7 +22202,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -23966,35 +22218,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing snapshot
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    returns snapshot
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    create or update an existing snapshot

    +

    returns snapshot

    -
    - -

    application/json application/xml -

    -
    -
    -

    snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    -

    -
    -
    -
    -
    - /snapshot -
    -
    -
    -
    @@ -24064,6 +22299,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /snapshot +
    +
    +
    + +
    default @@ -24071,7 +22329,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24087,16 +22345,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing snapshot
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    create or update an existing snapshot
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    update an existing snapshot

    +

    create or update an existing snapshot

    @@ -24105,13 +22363,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    snapshot object that needs to be created or updated.

    +

    snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    @@ -24192,7 +22450,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24208,22 +22466,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing snapshot
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    update an existing snapshot
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    delete an existing snapshot

    +

    update an existing snapshot

    application/json application/xml

    +
    +
    +

    snapshot object that needs to be updated.

    +

    +
    +
    +
    +
    + /snapshot +
    +
    +
    @@ -24285,22 +22555,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -24317,7 +22571,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24332,35 +22586,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    delete an existing snapshot
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing snapshot

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    -

    -
    -
    -
    - -
    -
    @@ -24422,6 +22664,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -24438,7 +22696,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24454,22 +22712,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    +

    +
    +
    +
    + +
    +
    @@ -24547,7 +22817,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24562,19 +22832,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns tenants
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns tenants

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -24621,32 +22896,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -24658,29 +22919,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /tenants -
    -
    -
    - -
    default @@ -24688,7 +22926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24703,17 +22941,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns tenant
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    returns tenants
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

    Tags: CloudInfrastructure
    -

    returns tenant

    +

    returns tenants

    @@ -24765,38 +23003,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen tenant-id
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type + snapshot-id -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    querypath string +
    -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -24811,7 +23017,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen tenant-name -

    Readable name of tenant

    query @@ -24826,7 +23031,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen tenant-context -

    This field will store the tenant context.

    query @@ -24862,7 +23066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -24875,7 +23079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -24891,35 +23095,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing tenant
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    returns tenant
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    create or update an existing tenant

    +

    returns tenant

    -
    - -

    application/json application/xml -

    -
    -
    -

    tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    -

    -
    -
    -
    -
    - /tenant -
    -
    -
    -
    @@ -24989,6 +23176,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /tenant +
    +
    +
    + +
    default @@ -24996,7 +23206,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25012,16 +23222,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing tenant
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    create or update an existing tenant
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    update an existing tenant

    +

    create or update an existing tenant

    @@ -25030,13 +23240,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tenant object that needs to be created or updated.

    +

    tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    @@ -25117,7 +23327,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25133,22 +23343,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing tenant
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    update an existing tenant
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    delete an existing tenant

    +

    update an existing tenant

    application/json application/xml

    +
    +
    +

    tenant object that needs to be updated.

    +

    +
    +
    +
    +
    + /tenant +
    +
    +
    @@ -25210,22 +23432,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -25242,7 +23448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25257,35 +23463,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    delete an existing tenant
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing tenant

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    -

    -
    -
    -
    - -
    -
    @@ -25347,6 +23541,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -25363,7 +23573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25379,22 +23589,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    +

    +
    +
    +
    + +
    +
    @@ -25472,7 +23694,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25487,19 +23709,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vservers
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns vservers

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -25560,66 +23787,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    @@ -25629,29 +23796,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vservers -
    -
    -
    - -
    default @@ -25659,7 +23803,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25674,17 +23818,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vserver
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    returns vservers
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    Tags: CloudInfrastructure
    -

    returns vserver

    +

    returns vservers

    @@ -25752,68 +23896,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vserver-id
    -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    query @@ -25828,7 +23910,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vserver-name -

    Name of vserver

    query @@ -25843,7 +23924,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vserver-name2 -

    Alternative name of vserver

    query @@ -25858,7 +23938,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -25922,7 +24001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -25935,7 +24014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -25951,35 +24030,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing vserver
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    returns vserver
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    Tags: CloudInfrastructure
    -

    create or update an existing vserver

    +

    returns vserver

    -
    - -

    application/json application/xml -

    -
    -
    -

    vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    -

    -
    -
    -
    -
    - /vserver -
    -
    -
    -
    @@ -26065,6 +24127,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vserver +
    +
    +
    + +
    default @@ -26072,7 +24157,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -26088,16 +24173,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing vserver
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    create or update an existing vserver
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    Tags: CloudInfrastructure
    -

    update an existing vserver

    +

    create or update an existing vserver

    @@ -26106,13 +24191,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vserver object that needs to be created or updated.

    +

    vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -26209,7 +24294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -26225,22 +24310,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing vserver
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    update an existing vserver
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    Tags: CloudInfrastructure
    -

    delete an existing vserver

    +

    update an existing vserver

    application/json application/xml

    +
    +
    +

    vserver object that needs to be updated.

    +

    +
    +
    +
    +
    + /vserver +
    +
    +
    @@ -26318,22 +24415,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -26350,7 +24431,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -26365,19 +24446,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

    +
    delete an existing vserver
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    Tags: CloudInfrastructure
    -

    returns l-interfaces

    +

    delete an existing vserver

    +
    + +

    application/json application/xml +

    +
    @@ -26456,100 +24542,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -26596,29 +24565,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -26626,7 +24572,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -26641,17 +24587,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    returns l-interfaces

    @@ -26735,38 +24681,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - - - - - - - - - - - - - - + +
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status + resource-version -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    resource-version for concurrency

    query @@ -26557,34 +24553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - +
    -

    Name given to the interface

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -26778,10 +24692,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-name + interface-id -

    Readable name of tenant

    query @@ -26793,10 +24706,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-context + macaddr -

    This field will store the tenant context.

    query @@ -26808,10 +24720,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-name + network-name -

    Name of vserver

    query @@ -26821,107 +24732,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l-interface
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns l-interface

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - - - - - - - - + - + - + @@ -26963,7 +24930,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -27116,7 +25083,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -27150,7 +25117,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated.

    +

    l-interface object that needs to be updated.

    @@ -27269,7 +25236,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -27426,7 +25393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -27562,229 +25529,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vserver-name2 + cloud-owner -

    Alternative name of vserver

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - prov-status + cloud-region-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + tenant-id -

    ID of interface

    +

    Unique id relative to the cloud-region.

    querypath string +
    - macaddr + vserver-id -

    MAC address for the interface

    +

    Unique identifier for this vserver relative to its tenant

    querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name given to the interface

    querypath string +
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -27824,7 +25568,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -27993,7 +25737,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -28027,7 +25771,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -28162,7 +25906,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -28335,7 +26079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -28504,7 +26248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -28661,7 +26405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -28797,229 +26541,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -29059,7 +26580,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -29228,7 +26749,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -29262,7 +26783,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -29397,7 +26918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -29570,7 +27091,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -29739,7 +27260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -29896,7 +27417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -30049,7 +27570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -30190,7 +27711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -30312,70 +27833,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name + pci-id -

    Name of vserver

    query @@ -30387,10 +27847,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-name2 + vf-vlan-filter -

    Alternative name of vserver

    query @@ -30402,10 +27861,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vf-mac-filter -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -30417,21 +27875,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled + vf-vlan-strip
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name + neutron-network-id -

    Name of the network

    query @@ -30527,7 +27940,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -30663,244 +28076,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vf-vlan-filter - -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    -
    query - string - - -
    - vf-mac-filter - -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    -
    query - string - - -
    - vf-vlan-strip - -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    -
    query - boolean - - -
    - neutron-network-id - -

    Neutron network id of the interface

    -
    query - string - - -
    @@ -30940,7 +28115,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31109,7 +28284,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31143,7 +28318,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated.

    +

    sriov-vf object that needs to be updated.

    @@ -31278,7 +28453,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31451,7 +28626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31620,7 +28795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31777,7 +28952,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -31899,143 +29074,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type - - -

    Type of the cloud (e.g., openstack)

    - - query - - string - - - - - - - - owner-defined-type - - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    - - query - - string - - - - - - - - tenant-name - - -

    Readable name of tenant

    - - query - - string - - - - - - - - tenant-context - - -

    This field will store the tenant context.

    - - query - - string - - - - - - - - vserver-name - - -

    Name of vserver

    - - query - - string - - - - - - - - vserver-name2 - - -

    Alternative name of vserver

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - interface-id + vlan-interface -

    ID of interface

    query @@ -32047,14 +29088,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - macaddr + vlan-id-inner -

    MAC address for the interface

    query - string + integer @@ -32062,10 +29102,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name + vpn-key -

    Name of the network

    query @@ -32114,7 +29153,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -32250,212 +29289,196 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing vlan
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    create or update an existing vlan

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -32467,29 +29490,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -32497,7 +29497,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -32513,16 +29513,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    create or update an existing vlan

    +

    update an existing vlan

    @@ -32531,13 +29531,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    +

    vlan object that needs to be updated.

    - /vlan + /vlan
    @@ -32666,7 +29666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -32682,34 +29682,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    update an existing vlan
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    delete an existing vlan
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    update an existing vlan

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    vlan object that needs to be created or updated.

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 + cloud-owner -

    Alternative name of vserver

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - prov-status + cloud-region-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + tenant-id -

    ID of interface

    +

    Unique id relative to the cloud-region.

    querypath string +
    - macaddr + vserver-id -

    MAC address for the interface

    +

    Unique identifier for this vserver relative to its tenant

    querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name given to the interface

    querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key + vlan-interface -

    This indicates the customers VPN ID associated with this vlan

    +

    String that identifies the interface

    querypath string +
    @@ -32819,6 +29807,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -32835,7 +29839,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -32850,24 +29854,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns l3-interface-ipv4-address-list
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    delete an existing vlan

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -32978,12 +29977,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    querypath string @@ -33001,6 +30000,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + + + +
    default @@ -33008,7 +30030,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -33024,18 +30046,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv4-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    + +
    +
    @@ -33160,250 +30199,370 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    update an existing l3-interface-ipv4-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be updated.

    +

    +
    + +
    +
    +
    + + + + + + + + + + + - + - + - + - + - + - + - + + +
    - cloud-type + cloud-owner -

    Type of the cloud (e.g., openstack)

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - owner-defined-type + cloud-region-id -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - tenant-name + tenant-id -

    Readable name of tenant

    +

    Unique id relative to the cloud-region.

    querypath string +
    - tenant-context + vserver-id -

    This field will store the tenant context.

    +

    Unique identifier for this vserver relative to its tenant

    querypath string +
    - vserver-name + interface-name -

    Name of vserver

    +

    Name given to the interface

    querypath string +
    - vserver-name2 + vlan-interface -

    Alternative name of vserver

    +

    String that identifies the interface

    querypath string +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing l3-interface-ipv4-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + - + - + - + @@ -33422,29 +30582,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - - - -
    default @@ -33452,7 +30589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -33467,17 +30604,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -33486,13 +30623,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -33637,7 +30774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -33652,35 +30789,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    update an existing l3-interface-ipv4-address-list
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    update an existing l3-interface-ipv4-address-list

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    -

    -
    - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + cloud-owner -

    ID of interface

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - macaddr + cloud-region-id -

    MAC address for the interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - network-name + tenant-id -

    Name of the network

    +

    Unique id relative to the cloud-region.

    querypath string +
    - vlan-id-inner + vserver-id -

    Inner VLAN tag

    +

    Unique identifier for this vserver relative to its tenant

    querypath - integer + string +
    - vpn-key + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name given to the interface

    querypath string +
    - vlan-id-inner + vlan-interface -

    Inner VLAN tag

    +

    String that identifies the interface

    querypath - integer + string +
    - neutron-network-id + l3-interface-ipv4-address -

    Neutron network id of the interface that address belongs to

    +

    IP address

    querypath string +
    - neutron-subnet-id + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    query @@ -33411,6 +30570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -33822,7 +30947,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -33837,24 +30962,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns l3-interface-ipv6-address-list
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    delete an existing l3-interface-ipv4-address-list

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -33965,7 +31085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -33979,14 +31099,206 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + + + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    create or update an existing l3-interface-ipv6-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    + +
    +
    +
    + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - resource-version + cloud-owner -

    resource-version for concurrency

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +
    path + string + + + +
    + tenant-id + +

    Unique id relative to the cloud-region.

    +
    path + string + + + +
    + vserver-id + +

    Unique identifier for this vserver relative to its tenant

    +
    path + string + + + +
    + interface-name + +

    Name given to the interface

    +
    path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +
    path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +
    path string @@ -34011,7 +31323,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -34026,17 +31338,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -34045,13 +31357,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -34166,7 +31478,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -34196,7 +31508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -34211,17 +31523,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -34339,7 +31651,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -34353,6 +31665,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -34369,7 +31697,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -34384,19 +31712,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    + +
    +
    +
    @@ -34521,257 +31866,177 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + - + - + - - - - - - - - + - - - - - - - - + - + @@ -34783,29 +32048,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - - - -
    default @@ -34813,7 +32055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -34828,17 +32070,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    @@ -34847,13 +32089,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    @@ -34966,22 +32208,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status + cloud-owner -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    querypath string +
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + cloud-region-id -

    ID of interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    querypath string +
    - macaddr + tenant-id -

    MAC address for the interface

    +

    Unique id relative to the cloud-region.

    querypath string +
    - network-name + vserver-id -

    Name of the network

    +

    Unique identifier for this vserver relative to its tenant

    querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name given to the interface

    querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id + vlan-interface -

    Neutron network id of the interface that address belongs to

    +

    String that identifies the interface

    querypath string +
    - neutron-subnet-id + l3-interface-ipv6-address -

    Neutron id of subnet that address belongs to

    +

    IP address

    querypath string +
    - l3-interface-ipv6-address - -

    IP address

    -
    path - string - - - -
    @@ -34998,7 +32224,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35013,35 +32239,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    update an existing l3-interface-ipv6-address-list
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    update an existing l3-interface-ipv6-address-list

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    -

    -
    - -
    @@ -35151,22 +32365,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address - -

    IP address

    -
    path - string - - - -
    @@ -35183,7 +32381,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35198,23 +32396,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    +

    +
    +
    +
    + +
    +
    @@ -35292,12 +32502,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + + +
    - interface-name + cloud-owner -

    Name given to the interface

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    path @@ -35310,10 +32581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + cloud-region-id -

    String that identifies the interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    path @@ -35326,10 +32597,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + tenant-id -

    IP address

    +

    Unique id relative to the cloud-region.

    path @@ -35342,12 +32613,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vserver-id -

    resource-version for concurrency

    +

    Unique identifier for this vserver relative to its tenant

    querypath string @@ -35372,7 +32643,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35387,36 +32658,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns volumes
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns volumes

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -35495,50 +32749,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -35550,6 +32770,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /volumes +
    +
    +
    + +
    default @@ -35557,7 +32800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35572,24 +32815,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns volume
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns volume

    -
    - -

    application/json application/xml -

    -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -
    path - string - - - -
    - l3-interface-ipv6-address + volume-id -

    IP address

    pathquery string -
    @@ -35668,42 +32906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -
    path - string - - - -
    - l3-interface-ipv6-address + volume-id -

    IP address

    +

    Unique ID of block storage volume relative to the vserver.

    path @@ -35723,6 +32929,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /volume +
    +
    +
    + +
    default @@ -35730,7 +32959,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35745,17 +32974,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    create or update an existing volume
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    create or update an existing volume

    @@ -35764,13 +32993,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    +

    volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    @@ -35853,26 +33082,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - vlan-interface + volume-id -

    String that identifies the interface

    +

    Unique ID of block storage volume relative to the vserver.

    path @@ -35899,7 +33112,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -35914,23 +33127,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    update an existing volume
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing volume

    application/json application/xml

    +
    +
    +

    volume object that needs to be updated.

    +

    +
    +
    +
    +
    + /volume +
    +
    +
    @@ -36010,26 +33235,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - vlan-interface + volume-id -

    String that identifies the interface

    +

    Unique ID of block storage volume relative to the vserver.

    path @@ -36056,7 +33265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -36071,35 +33280,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

    +
    delete an existing volume
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing volume

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    -

    -
    -
    -
    - -
    -
    @@ -36177,6 +33374,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    + volume-id + +

    Unique ID of block storage volume relative to the vserver.

    +
    path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -36193,7 +33422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -36208,23 +33437,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    +

    +
    +
    +
    + +
    +
    @@ -36302,6 +33543,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + volume-id + +

    Unique ID of block storage volume relative to the vserver.

    +
    path + string + + + +
    @@ -36318,7 +33575,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -36333,19 +33590,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volumes
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns volumes

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -36424,135 +33686,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - @@ -36564,29 +33709,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /volumes -
    -
    -
    - -
    default @@ -36594,7 +33716,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -36609,17 +33731,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volume
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    returns vip-ipv4-address-list
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    Tags: CloudInfrastructure
    -

    returns volume

    +

    returns vip-ipv4-address-list

    @@ -36668,42 +33790,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status + volume-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique ID of block storage volume relative to the vserver.

    querypath string -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - +
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -36714,139 +33804,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - tenant-name - -

    Readable name of tenant

    -
    query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -
    query - string - - -
    - vserver-name - -

    Name of vserver

    -
    query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    @@ -36873,7 +33830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -36886,7 +33843,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -36901,17 +33858,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing volume
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    create or update an existing vip-ipv4-address-list
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    Tags: CloudInfrastructure
    -

    create or update an existing volume

    +

    create or update an existing vip-ipv4-address-list

    @@ -36920,13 +33877,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    +

    vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    @@ -36977,42 +33934,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -37039,7 +33964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37054,17 +33979,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    update an existing volume
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    update an existing vip-ipv4-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    Tags: CloudInfrastructure
    -

    update an existing volume

    +

    update an existing vip-ipv4-address-list

    @@ -37073,13 +33998,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume object that needs to be created or updated.

    +

    vip-ipv4-address-list object that needs to be updated.

    @@ -37130,42 +34055,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -37192,7 +34085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37207,17 +34100,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing volume
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    delete an existing vip-ipv4-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    Tags: CloudInfrastructure
    -

    delete an existing volume

    +

    delete an existing vip-ipv4-address-list

    @@ -37271,42 +34164,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -37349,7 +34210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37364,11 +34225,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -37383,7 +34244,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    @@ -37440,42 +34301,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -37502,7 +34331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37517,11 +34346,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -37581,42 +34410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-id - -

    Unique id relative to the cloud-region.

    -
    path - string - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -
    path - string - - - -
    - volume-id + vip-ipv4-address -

    Unique ID of block storage volume relative to the vserver.

    +

    IP address

    path @@ -37643,7 +34440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37658,17 +34455,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vip-ipv4-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    returns vip-ipv6-address-list
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    Tags: CloudInfrastructure
    -

    returns vip-ipv4-address-list

    +

    returns vip-ipv6-address-list

    @@ -37717,7 +34514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -37731,81 +34528,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -37832,7 +34554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -37845,7 +34567,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37860,17 +34582,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vip-ipv4-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    create or update an existing vip-ipv6-address-list
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    Tags: CloudInfrastructure
    -

    create or update an existing vip-ipv4-address-list

    +

    create or update an existing vip-ipv6-address-list

    @@ -37879,13 +34601,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    +

    vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    @@ -37936,7 +34658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -37966,7 +34688,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -37981,17 +34703,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    update an existing vip-ipv4-address-list
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    update an existing vip-ipv6-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    Tags: CloudInfrastructure
    -

    update an existing vip-ipv4-address-list

    +

    update an existing vip-ipv6-address-list

    @@ -38000,13 +34722,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vip-ipv4-address-list object that needs to be created or updated.

    +

    vip-ipv6-address-list object that needs to be updated.

    @@ -38057,7 +34779,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -38087,7 +34809,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38102,17 +34824,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vip-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    delete an existing vip-ipv6-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    Tags: CloudInfrastructure
    -

    delete an existing vip-ipv4-address-list

    +

    delete an existing vip-ipv6-address-list

    @@ -38166,7 +34888,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -38212,7 +34934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38227,11 +34949,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -38246,7 +34968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    @@ -38303,7 +35025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -38333,7 +35055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38348,11 +35070,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -38412,7 +35134,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv4-address + vip-ipv6-address

    IP address

    @@ -38442,7 +35164,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38457,17 +35179,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vip-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    returns volume-groups
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    Tags: CloudInfrastructure
    -

    returns vip-ipv6-address-list

    +

    returns volume-groups

    @@ -38516,26 +35238,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv6-address - -

    IP address

    -
    path - string - - - -
    - cloud-type + volume-group-id -

    Type of the cloud (e.g., openstack)

    query @@ -38547,10 +35252,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - owner-defined-type + volume-group-name -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    query @@ -38562,25 +35266,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id + heat-stack-id -

    Neutron network id of the interface that address belongs to

    query @@ -38592,10 +35280,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + vnf-type -

    Neutron id of subnet that address belongs to

    query @@ -38631,7 +35318,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -38644,7 +35331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38659,36 +35346,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vip-ipv6-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    returns volume-group
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    create or update an existing vip-ipv6-address-list

    +

    returns volume-group

    -
    - -

    application/json application/xml -

    -
    -
    -

    vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    -

    -
    - -
    -
    @@ -38735,10 +35405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - vip-ipv6-address + volume-group-id -

    IP address

    +

    Unique ID of volume-group.

    path @@ -38758,6 +35428,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    default @@ -38765,7 +35458,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38780,17 +35473,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    update an existing vip-ipv6-address-list
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    create or update an existing volume-group
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    update an existing vip-ipv6-address-list

    +

    create or update an existing volume-group

    @@ -38799,13 +35492,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vip-ipv6-address-list object that needs to be created or updated.

    +

    volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    @@ -38856,10 +35549,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv6-address + volume-group-id -

    IP address

    +

    Unique ID of volume-group.

    path @@ -38886,7 +35579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -38901,23 +35594,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vip-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    update an existing volume-group
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    delete an existing vip-ipv6-address-list

    +

    update an existing volume-group

    application/json application/xml

    +
    +
    +

    volume-group object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    @@ -38965,10 +35670,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vip-ipv6-address + volume-group-id -

    IP address

    +

    Unique ID of volume-group.

    path @@ -38979,22 +35684,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -39011,7 +35700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -39026,35 +35715,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    +
    delete an existing volume-group
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing volume-group

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    -

    -
    -
    -
    - -
    -
    @@ -39102,10 +35779,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - vip-ipv6-address + volume-group-id -

    IP address

    +

    Unique ID of volume-group.

    path @@ -39116,6 +35793,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -39132,7 +35825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -39147,269 +35840,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    +

    +
    +
    +
    + +
    +
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - vip-ipv6-address - -

    IP address

    -
    path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns volume-groups
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns volume-groups

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns volume-group
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns volume-group

    - -
    @@ -39470,81 +35930,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -
    query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    query - string - - -
    - volume-group-name - -

    Name of the volume group.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this volume-group

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    @@ -39554,29 +35939,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -39584,7 +35946,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -39599,156 +35961,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    -
    -
    create or update an existing volume-group
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    create or update an existing volume-group

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    -

    -
    -
    -
    - -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - volume-group-id - -

    Unique ID of volume-group.

    -
    path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    + +
    -
    update an existing volume-group
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    update an existing volume-group

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    volume-group object that needs to be created or updated.

    -

    -
    -
    -
    - -
    -
    @@ -39826,7 +36055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -39841,24 +36070,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing volume-group
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    returns complexes
    +

    GET /cloud-infrastructure/complexes

    Tags: CloudInfrastructure
    -

    delete an existing volume-group

    +

    returns complexes

    -
    - -

    application/json application/xml -

    -
    @@ -39873,58 +36097,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - volume-group-id - -

    Unique ID of volume-group.

    -
    path - string - - - -
    - resource-version + physical-location-id -

    resource-version for concurrency

    query @@ -39932,284 +36107,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    see node definition for valid relationships

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    -

    -
    -
    -
    - -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-owner - -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    path - string - - - -
    - cloud-region-id - -

    Identifier used by the vendor for the region. Second part of composite key

    -
    path - string - - - -
    - volume-group-id - -

    Unique ID of volume-group.

    -
    path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - + - +
    - cloud-owner + data-center-code -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    pathquery string -
    - cloud-region-id + complex-name -

    Identifier used by the vendor for the region. Second part of composite key

    pathquery string -
    - volume-group-id + identity-url -

    Unique ID of volume-group.

    pathquery string -
    -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns complexes
    -

    GET /cloud-infrastructure/complexes

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns complexes

    - -
    -

    application/json application/xml

    @@ -40245,7 +36190,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40301,51 +36246,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code - -

    Data center code which can be an alternate way to identify a complex

    -
    query - string - - -
    - complex-name - -

    Gamma complex name for LCP instance.

    -
    query - string - - -
    - identity-url - -

    URL of the keystone identity service

    -
    query - string - - -
    @@ -40385,7 +36285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40474,7 +36374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40508,7 +36408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    complex object that needs to be created or updated.

    +

    complex object that needs to be updated.

    @@ -40563,7 +36463,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40656,7 +36556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40714,40 +36614,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code - -

    Data center code which can be an alternate way to identify a complex

    -
    query - string - - -
    - complex-name - -

    Gamma complex name for LCP instance.

    -
    query - string - - -
    - identity-url + availability-zone-name -

    URL of the keystone identity service

    query @@ -40796,7 +36665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -40884,51 +36753,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code - -

    Data center code which can be an alternate way to identify a complex

    -
    query - string - - -
    - complex-name - -

    Gamma complex name for LCP instance.

    -
    query - string - - -
    - identity-url - -

    URL of the keystone identity service

    -
    query - string - - -
    @@ -40968,7 +36792,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41089,7 +36913,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41123,7 +36947,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-pool object that needs to be created or updated.

    +

    ctag-pool object that needs to be updated.

    @@ -41210,7 +37034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41335,7 +37159,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41456,7 +37280,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41565,7 +37389,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41654,7 +37478,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41731,7 +37555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41759,6 +37583,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns network-profiles

    +
    + + + + + + + + + + + + + + + + + + + +
    + nm-profile-name + + query + string + + +
    +

    application/json application/xml @@ -41795,7 +37648,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41890,7 +37743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -41979,7 +37832,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42013,7 +37866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-profile object that needs to be created or updated.

    +

    network-profile object that needs to be updated.

    @@ -42068,7 +37921,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42161,7 +38014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42250,7 +38103,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42327,7 +38180,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42354,70 +38207,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns pservers

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /pservers -
    -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    - - - - -
    -
    -
    returns pserver
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns pserver

    -
    @@ -42436,15 +38225,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen hostname - + @@ -42452,7 +38239,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen inv-status - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Value from executing hostname on the compute node.

    pathquery string -
    -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -42467,7 +38253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen pserver-id -

    ID of Pserver

    query @@ -42496,7 +38281,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen pserver-name2 -

    alternative pserver name

    query @@ -42532,7 +38316,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -42545,7 +38329,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42561,35 +38345,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing pserver
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    +
    returns pserver
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    create or update an existing pserver

    +

    returns pserver

    -
    - -

    application/json application/xml -

    -
    -
    -

    pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

    -

    -
    -
    -
    -
    - /pserver -
    -
    -
    -
    @@ -42627,6 +38394,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /pserver +
    +
    +
    + +
    default @@ -42634,7 +38424,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42650,16 +38440,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing pserver
    -

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    +
    create or update an existing pserver
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    update an existing pserver

    +

    create or update an existing pserver

    @@ -42668,13 +38458,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pserver object that needs to be created or updated.

    +

    pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

    @@ -42723,7 +38513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42739,22 +38529,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing pserver
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}

    +
    update an existing pserver
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    delete an existing pserver

    +

    update an existing pserver

    application/json application/xml

    +
    +
    +

    pserver object that needs to be updated.

    +

    +
    +
    +
    +
    + /pserver +
    +
    +
    @@ -42784,22 +38586,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -42816,7 +38602,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42831,19 +38617,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

    +
    delete an existing pserver
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    returns lag-interfaces

    +

    delete an existing pserver

    +
    + +

    application/json application/xml +

    +
    @@ -42874,54 +38665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -42940,29 +38688,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -42970,7 +38695,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -42985,17 +38710,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    +
    returns lag-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

    Tags: CloudInfrastructure
    -

    returns lag-interface

    +

    returns lag-interfaces

    @@ -43031,23 +38756,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - - - - - - - - - - - - - - + +
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 + resource-version -

    alternative pserver name

    +

    resource-version for concurrency

    query @@ -42929,6 +38676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    -

    Name that identifies the link aggregate interface

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -43059,10 +38767,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + interface-id -

    ID of Pserver

    query @@ -43074,24 +38781,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - pserver-name2 + interface-role -

    alternative pserver name

    query @@ -43101,34 +38793,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns lag-interface
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns lag-interface

    + +
    +
    + + + + + + + + + + + - + - + @@ -43170,7 +38943,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -43275,7 +39048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -43309,7 +39082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated.

    +

    lag-interface object that needs to be updated.

    @@ -43380,7 +39153,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -43489,7 +39262,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -43563,10 +39336,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    - interface-id + hostname -

    ID of interface

    +

    Value from executing hostname on the compute node.

    querypath string +
    - interface-role + interface-name -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Name that identifies the link aggregate interface

    querypath string +
    - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -43578,10 +39350,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + interface-id -

    ID of Pserver

    query @@ -43593,13 +39364,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + macaddr query - boolean + string @@ -43607,10 +39378,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-name2 + network-name -

    alternative pserver name

    query @@ -43620,34 +39390,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l-interface
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns l-interface

    + +
    +
    + + + + + + + + + + + - + - + + + + + + + + @@ -43676,7 +39543,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -43689,7 +39556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -43705,296 +39572,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    create or update an existing l-interface
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    create or update an existing l-interface

    -
    -
    - interface-id + hostname -

    ID of interface

    +

    Value from executing hostname on the compute node.

    querypath string +
    - interface-role + interface-name -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Name that identifies the link aggregate interface

    querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +
    path string +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -
    path - string - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    create or update an existing l-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    create or update an existing l-interface

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    -

    -
    -
    -
    - -
    -
    -
    +
    + +

    application/json application/xml +

    +
    +
    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    + +
    +
    +
    @@ -44071,7 +39677,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -44105,7 +39711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated.

    +

    l-interface object that needs to be updated.

    @@ -44192,7 +39798,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -44317,7 +39923,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -44421,185 +40027,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -44639,7 +40066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -44776,7 +40203,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -44810,7 +40237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -44913,7 +40340,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45054,7 +40481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45191,7 +40618,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45316,7 +40743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45420,185 +40847,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -45638,7 +40886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45775,7 +41023,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -45809,7 +41057,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -45912,7 +41160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46053,7 +41301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46190,7 +41438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46315,7 +41563,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46436,7 +41684,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46545,7 +41793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -46635,10 +41883,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + pci-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -46650,10 +41897,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + vf-vlan-filter -

    ID of Pserver

    query @@ -46665,13 +41911,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + vf-mac-filter query - boolean + string @@ -46679,14 +41925,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-name2 + vf-vlan-strip -

    alternative pserver name

    query - string + boolean @@ -46694,10 +41939,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + neutron-network-id -

    ID of interface

    query @@ -46707,401 +41951,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns sriov-vf
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns sriov-vf

    + +
    +
    + + + + + + + + + + + - + - + - + - - - - - -
    - interface-role + hostname -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Value from executing hostname on the compute node.

    querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name that identifies the link aggregate interface

    querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name given to the interface

    querypath string +
    - network-name + pci-id -

    Name of the network

    +

    PCI ID used to identify the sriov-vf

    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns sriov-vf

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -47143,7 +42133,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47280,7 +42270,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47314,7 +42304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated.

    +

    sriov-vf object that needs to be updated.

    @@ -47417,7 +42407,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47558,7 +42548,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47695,7 +42685,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47820,7 +42810,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -47910,99 +42900,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -
    path - string - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vf-vlan-filter - -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    -
    query - string - - -
    - vf-mac-filter - -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    -
    query - string - - -
    - vf-vlan-strip - -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    -
    query - boolean - - -
    - neutron-network-id - -

    Neutron network id of the interface

    -
    querypath string +
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id + vlan-interface -

    ID of interface

    query @@ -48014,14 +42914,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    query - string + integer @@ -48029,10 +42928,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-key -

    Name of the network

    query @@ -48081,7 +42979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -48185,170 +43083,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -
    query - string - - -
    @@ -48388,7 +43122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -48525,7 +43259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -48559,7 +43293,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated.

    +

    vlan object that needs to be updated.

    @@ -48662,7 +43396,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -48803,7 +43537,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -48923,215 +43657,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -49171,7 +43696,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -49324,7 +43849,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -49358,7 +43883,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -49477,7 +44002,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -49634,7 +44159,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -49787,7 +44312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -49928,7 +44453,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -50048,215 +44573,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -50296,7 +44612,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -50449,7 +44765,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -50483,7 +44799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -50602,7 +44918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -50759,7 +45075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -50912,7 +45228,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51053,7 +45369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51190,7 +45506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51315,7 +45631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51420,7 +45736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51513,7 +45829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51571,10 +45887,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -51586,10 +45901,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - pserver-id + prov-status -

    ID of Pserver

    query @@ -51599,33 +45913,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns p-interface
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns p-interface

    + +
    +
    + + + + + + + + + + + - + - + @@ -51654,7 +46050,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -51667,7 +46063,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51683,18 +46079,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns p-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    create or update an existing p-interface
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns p-interface

    +

    create or update an existing p-interface

    +
    + +

    application/json application/xml +

    +
    +
    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    +

    +
    +
    +
    + +
    +
    +
    - in-maint + hostname +

    Value from executing hostname on the compute node.

    querypath - boolean + string +
    - pserver-name2 + interface-name -

    alternative pserver name

    +

    Name that identifies the physical interface

    querypath string +
    @@ -51739,80 +46152,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    @@ -51822,29 +46161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -51852,7 +46168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51868,16 +46184,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing p-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    update an existing p-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    create or update an existing p-interface

    +

    update an existing p-interface

    @@ -51886,13 +46202,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    +

    p-interface object that needs to be updated.

    @@ -51957,7 +46273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -51973,34 +46289,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    update an existing p-interface
    -

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    delete an existing p-interface
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    update an existing p-interface

    +

    delete an existing p-interface

    application/json application/xml

    -
    -
    -

    p-interface object that needs to be created or updated.

    -

    -
    -
    -
    - -
    -
    @@ -52046,6 +46350,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -52062,7 +46382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -52077,24 +46397,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: CloudInfrastructure
    -

    delete an existing p-interface

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -52141,10 +46456,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + @@ -52164,6 +46519,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    default @@ -52171,7 +46549,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -52186,202 +46564,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    returns l-interface
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns l-interfaces

    - -
    -
    -
    - resource-version + interface-name + + query + string + + +
    + interface-id + + query + string + + +
    + macaddr + + query + string + + +
    + network-name -

    resource-version for concurrency

    query @@ -52152,7 +46508,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns l-interface

    +

    returns l-interface

    @@ -52444,125 +46637,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - -
    @@ -52602,7 +46676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -52723,7 +46797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -52757,7 +46831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated.

    +

    l-interface object that needs to be updated.

    @@ -52844,7 +46918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -52969,7 +47043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53073,170 +47147,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -53276,7 +47186,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53413,7 +47323,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53447,7 +47357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -53550,7 +47460,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53691,7 +47601,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53828,7 +47738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -53953,7 +47863,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54057,170 +47967,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -54260,7 +48006,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54397,7 +48143,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54431,7 +48177,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -54534,7 +48280,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54675,7 +48421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54812,7 +48558,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -54937,7 +48683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -55058,7 +48804,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -55167,7 +48913,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -55257,10 +49003,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - inv-status + pci-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -55272,10 +49017,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - pserver-id + vf-vlan-filter -

    ID of Pserver

    query @@ -55287,7 +49031,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - in-maint + vf-mac-filter + + + + query + + string + + + + + + + + vf-vlan-strip @@ -55301,10 +49059,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - pserver-name2 + neutron-network-id -

    alternative pserver name

    query @@ -55314,386 +49071,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns sriov-vf
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns sriov-vf

    + +
    +
    + + + + + + + + + + + - + - + - + - - - - - -
    - prov-status + hostname -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Value from executing hostname on the compute node.

    querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name that identifies the physical interface

    querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name given to the interface

    querypath string +
    - network-name + pci-id -

    Name of the network

    +

    PCI ID used to identify the sriov-vf

    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns sriov-vf

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -55735,7 +49253,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -55872,7 +49390,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -55906,7 +49424,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated.

    +

    sriov-vf object that needs to be updated.

    @@ -56009,7 +49527,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -56150,7 +49668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -56287,7 +49805,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -56412,7 +49930,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -56502,84 +50020,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -
    path - string - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vf-vlan-filter - -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    -
    query - string - - -
    - vf-mac-filter - -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    -
    query - string - - -
    - vf-vlan-strip - -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    -
    query - boolean - - -
    - neutron-network-id - -

    Neutron network id of the interface

    -
    querypath string +
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - interface-id + vlan-interface -

    ID of interface

    query @@ -56591,14 +50034,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    query - string + integer @@ -56606,10 +50048,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-key -

    Name of the network

    query @@ -56658,7 +50099,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -56762,155 +50203,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -
    query - string - - -
    @@ -56950,7 +50242,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57087,7 +50379,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57121,7 +50413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated.

    +

    vlan object that needs to be updated.

    @@ -57224,7 +50516,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57365,7 +50657,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57485,200 +50777,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -57718,7 +50816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57871,7 +50969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -57905,7 +51003,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -58024,7 +51122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -58181,7 +51279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -58334,7 +51432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -58475,7 +51573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -58595,200 +51693,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - inv-status - - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    - - query - - string - - - - - - - - pserver-id - - -

    ID of Pserver

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - pserver-name2 - - -

    alternative pserver name

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -58828,7 +51732,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -58981,7 +51885,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59015,7 +51919,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -59134,7 +52038,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59291,7 +52195,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59444,7 +52348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59585,7 +52489,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59722,7 +52626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59847,7 +52751,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -59952,7 +52856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60045,7 +52949,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60119,10 +53023,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - inv-status + pf-pci-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    query @@ -60132,264 +53035,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns sriov-pf
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns sriov-pf

    + +
    +
    + + + + + + + + + + + - + - - - - - - - - + - - - - - -
    - pserver-id + hostname -

    ID of Pserver

    +

    Value from executing hostname on the compute node.

    querypath string +
    - in-maint - - query - boolean - - -
    - pserver-name2 + interface-name -

    alternative pserver name

    +

    Name that identifies the physical interface

    querypath string +
    - prov-status + pf-pci-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Identifier for the sriov-pf

    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns sriov-pf
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns sriov-pf

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -60431,7 +53201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60552,7 +53322,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60586,7 +53356,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-pf object that needs to be created or updated.

    +

    sriov-pf object that needs to be updated.

    @@ -60673,7 +53443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60798,7 +53568,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -60919,7 +53689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61028,7 +53798,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61117,7 +53887,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61194,7 +53964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61221,70 +53991,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns virtual-data-centers

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    - -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    - - - - -
    -
    -
    returns virtual-data-center
    -

    GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns virtual-data-center

    -
    - hostname - -

    Value from executing hostname on the compute node.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -
    path - string - - - -
    - pf-pci-id - -

    Identifier for the sriov-pf

    -
    path - string - - - -
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -
    query - string - - -
    - pserver-id - -

    ID of Pserver

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    querypath string +
    @@ -61303,15 +54009,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vdc-id - + @@ -61319,7 +54023,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vdc-name
    -

    Unique ID of the vdc

    pathquery string -
    -

    Name of the virtual data center

    query @@ -61333,6 +54036,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    + +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns virtual-data-center
    +

    GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns virtual-data-center

    + +
    +
    + + + + + + + + + + + + + + + + + + + +
    + vdc-id + +

    Unique ID of the vdc

    +
    path + string + + + +
    +
    +

    application/json application/xml

    @@ -61368,7 +54166,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61457,7 +54255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61491,7 +54289,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    virtual-data-center object that needs to be created or updated.

    +

    virtual-data-center object that needs to be updated.

    @@ -61546,7 +54344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61639,7 +54437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61728,7 +54526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61805,7 +54603,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -61832,70 +54630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns configurations

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns configuration
    -

    GET /network/configurations/configuration/{configuration-id}

    - Tags: - Network -
    -
    -
    -

    returns configuration

    -
    @@ -61914,15 +54648,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen configuration-id - + @@ -61930,7 +54662,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    UUID assigned to configuration.

    pathquery string -
    -

    the ASDC model id for this resource or service model.

    query @@ -61945,7 +54676,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

    the ASDC model version for this resource or service model.

    query @@ -61981,7 +54711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -61994,7 +54724,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62010,35 +54740,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing configuration
    -

    PUT /network/configurations/configuration/{configuration-id}

    +
    returns configuration
    +

    GET /network/configurations/configuration/{configuration-id}

    Tags: Network
    -

    create or update an existing configuration

    +

    returns configuration

    -
    - -

    application/json application/xml -

    -
    -
    -

    configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -62076,6 +54789,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    default @@ -62083,7 +54819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62099,16 +54835,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing configuration
    -

    PATCH /network/configurations/configuration/{configuration-id}

    +
    create or update an existing configuration
    +

    PUT /network/configurations/configuration/{configuration-id}

    Tags: Network
    -

    update an existing configuration

    +

    create or update an existing configuration

    @@ -62117,13 +54853,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    configuration object that needs to be created or updated.

    +

    configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

    @@ -62172,7 +54908,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62188,22 +54924,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing configuration
    -

    DELETE /network/configurations/configuration/{configuration-id}

    +
    update an existing configuration
    +

    PATCH /network/configurations/configuration/{configuration-id}

    Tags: Network
    -

    delete an existing configuration

    +

    update an existing configuration

    application/json application/xml

    +
    +
    +

    configuration object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    @@ -62233,22 +54981,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -62265,7 +54997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62280,19 +55012,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /network/configurations/configuration/{configuration-id}/metadata

    +
    delete an existing configuration
    +

    DELETE /network/configurations/configuration/{configuration-id}

    Tags: Network
    -

    returns metadata

    +

    delete an existing configuration

    +
    + +

    application/json application/xml +

    +
    @@ -62323,10 +55060,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
    - model-invariant-id + resource-version -

    the ASDC model id for this resource or service model.

    +

    resource-version for concurrency

    query @@ -62334,14 +55071,86 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns metadata
    +

    GET /network/configurations/configuration/{configuration-id}/metadata

    + Tags: + Network +
    +
    +
    +

    returns metadata

    + +
    +
    + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -
    + configuration-id + +

    UUID assigned to configuration.

    +
    path + string + + +
    - model-version-id + metaname -

    the ASDC model version for this resource or service model.

    query @@ -62390,7 +55199,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62461,36 +55270,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    @@ -62530,7 +55309,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62634,7 +55413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62668,7 +55447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated.

    +

    metadatum object that needs to be updated.

    @@ -62738,7 +55517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62846,7 +55625,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -62935,7 +55714,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63012,7 +55791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63039,70 +55818,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns generic-vnfs

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    - - - - -
    -
    -
    returns generic-vnf
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}

    - Tags: - Network -
    -
    -
    -

    returns generic-vnf

    -
    @@ -63121,15 +55836,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-id - + @@ -63137,7 +55850,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Unique id of VNF. This is unique across the graph.

    pathquery string -
    -

    Name of VNF.

    query @@ -63152,7 +55864,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name2 -

    Alternate name of VNF.

    query @@ -63167,7 +55878,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-type -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    query @@ -63182,7 +55892,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    query @@ -63197,7 +55906,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen regional-resource-zone -

    Regional way of organizing pservers, source of truth should define values

    query @@ -63212,7 +55920,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -63227,7 +55934,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

    Heat stack id corresponding to this instance, managed by MSO

    query @@ -63270,7 +55976,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id -

    the ASDC model id for this resource or service model.

    query @@ -63285,7 +55990,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

    the ASDC model version for this resource or service model.

    query @@ -63300,7 +56004,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -63315,7 +56018,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query @@ -63330,7 +56032,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-type -

    Generic description of the type of NF

    query @@ -63345,7 +56046,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-function -

    English description of Network function that the specific VNF deployment is providing

    query @@ -63360,7 +56060,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-role -

    role in the network that this model will be providing

    query @@ -63375,7 +56074,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-naming-code -

    string assigned to this model used for naming purposes

    query @@ -63411,7 +56109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -63424,7 +56122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63440,35 +56138,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing generic-vnf
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    returns generic-vnf
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    create or update an existing generic-vnf

    +

    returns generic-vnf

    -
    - -

    application/json application/xml -

    -
    -
    -

    generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -63506,6 +56187,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    default @@ -63513,7 +56217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63529,16 +56233,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    update an existing generic-vnf
    -

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    create or update an existing generic-vnf
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    update an existing generic-vnf

    +

    create or update an existing generic-vnf

    @@ -63547,13 +56251,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    generic-vnf object that needs to be created or updated.

    +

    generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)

    @@ -63602,7 +56306,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63618,22 +56322,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing generic-vnf
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    update an existing generic-vnf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    delete an existing generic-vnf

    +

    update an existing generic-vnf

    application/json application/xml

    +
    +
    +

    generic-vnf object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    @@ -63663,22 +56379,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -
    query - string - - - -
    @@ -63695,7 +56395,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -63710,19 +56410,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlements
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    +
    delete an existing generic-vnf
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    returns entitlements

    +

    delete an existing generic-vnf

    +
    + +

    application/json application/xml +

    +
    @@ -63753,203 +56458,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type + resource-version -

    Generic description of the type of NF

    +

    resource-version for concurrency

    query @@ -63957,29 +56469,86 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns entitlements
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    + Tags: + Network +
    +
    +
    +

    returns entitlements

    + +
    +
    + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - nf-function + vnf-id -

    English description of Network function that the specific VNF deployment is providing

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - nf-role + group-uuid -

    role in the network that this model will be providing

    query @@ -63991,10 +56560,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + resource-uuid -

    string assigned to this model used for naming purposes

    query @@ -64043,7 +56611,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -64131,259 +56699,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    @@ -64423,7 +56738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -64544,7 +56859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -64578,7 +56893,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    entitlement object that needs to be created or updated.

    +

    entitlement object that needs to be updated.

    @@ -64665,7 +56980,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -64790,7 +57105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -64911,7 +57226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -65020,7 +57335,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -65078,203 +57393,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type + interface-name -

    Generic description of the type of NF

    query @@ -65286,10 +57407,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-function + interface-id -

    English description of Network function that the specific VNF deployment is providing

    query @@ -65301,10 +57421,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-role + macaddr -

    role in the network that this model will be providing

    query @@ -65316,10 +57435,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + network-name -

    string assigned to this model used for naming purposes

    query @@ -65368,7 +57486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -65440,304 +57558,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    @@ -65777,7 +57597,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -65882,7 +57702,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -65916,7 +57736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated.

    +

    l-interface object that needs to be updated.

    @@ -65987,7 +57807,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -66096,7 +57916,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -66184,349 +58004,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -66566,7 +58043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -66687,7 +58164,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -66721,7 +58198,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -66808,7 +58285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -66933,7 +58410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -67054,7 +58531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -67163,7 +58640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -67251,349 +58728,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -67633,7 +58767,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -67754,7 +58888,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -67788,7 +58922,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -67875,7 +59009,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68000,7 +59134,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68121,7 +59255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68230,7 +59364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68335,7 +59469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68428,7 +59562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68502,70 +59636,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone + pci-id -

    Regional way of organizing pservers, source of truth should define values

    query @@ -68577,10 +59650,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vf-vlan-filter -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -68592,10 +59664,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - heat-stack-id + vf-mac-filter -

    Heat stack id corresponding to this instance, managed by MSO

    query @@ -68607,21 +59678,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled + vf-vlan-strip @@ -68635,160 +59692,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name + neutron-network-id -

    Name of the network

    query @@ -68837,7 +59743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -68925,364 +59831,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vf-vlan-filter - - -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    - - query - - string - - - - - - - - vf-mac-filter - - -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    - - query - - string - - - - - - - - vf-vlan-strip - - -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    - - query - - boolean - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface

    - - query - - string - - - - - @@ -69322,7 +59870,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69443,7 +59991,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69477,7 +60025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated.

    +

    sriov-vf object that needs to be updated.

    @@ -69564,7 +60112,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69689,7 +60237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69810,7 +60358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69919,7 +60467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -69993,263 +60541,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id + vlan-interface -

    ID of interface

    query @@ -70261,14 +60555,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - macaddr + vlan-id-inner -

    MAC address for the interface

    query - string + integer @@ -70276,10 +60569,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name + vpn-key -

    Name of the network

    query @@ -70328,7 +60620,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -70416,334 +60708,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - @@ -70783,7 +60747,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -70904,7 +60868,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -70938,7 +60902,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated.

    +

    vlan object that needs to be updated.

    @@ -71025,7 +60989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -71127,504 +61091,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen query - string - - - - - - - - - - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    - Tags: - Network -
    -
    -
    -

    returns l3-interface-ipv4-address-list

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -
    path - string - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -
    path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -
    path - string - - - -
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer + string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-interface-ipv4-address-list
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + Tags: + Network +
    +
    +
    +

    returns l3-interface-ipv4-address-list

    + +
    +
    + + + + + + + + + + + - + - + - + - + @@ -71666,7 +61257,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -71803,7 +61394,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -71837,7 +61428,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -71940,7 +61531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -72081,7 +61672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -72218,7 +61809,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -72343,7 +61934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -72447,379 +62038,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vpn-key + vnf-id -

    This indicates the customers VPN ID associated with this vlan

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - vlan-id-inner + interface-name -

    Inner VLAN tag

    +

    Name given to the interface

    querypath - integer + string +
    - neutron-network-id + vlan-interface -

    Neutron network id of the interface that address belongs to

    +

    String that identifies the interface

    querypath string +
    - neutron-subnet-id + l3-interface-ipv4-address -

    Neutron id of subnet that address belongs to

    +

    IP address

    querypath string +
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -
    query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -
    query - string - - -
    @@ -72859,7 +62077,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -72996,7 +62214,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73030,7 +62248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -73133,7 +62351,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73274,7 +62492,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73411,7 +62629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73536,7 +62754,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73657,7 +62875,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -73761,645 +62979,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    - -
    -
    - - -
    -
    -
    returns lag-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

    - Tags: - Network -
    -
    -
    -

    returns lag-interfaces

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -
    path - string - - - -
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns lag-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    - Tags: - Network -
    -
    -
    -

    returns lag-interface

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    + + + + + + +
    +
    +
    returns lag-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

    + Tags: + Network +
    +
    +
    +

    returns lag-interfaces

    + +
    +
    +
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -
    path - string - - - -
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    + + + + + + + + + + - + + +
    - nf-type + vnf-id -

    Generic description of the type of NF

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - nf-function + interface-name -

    English description of Network function that the specific VNF deployment is providing

    query @@ -74411,10 +63056,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-role + interface-id -

    role in the network that this model will be providing

    query @@ -74426,10 +63070,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + interface-role -

    string assigned to this model used for naming purposes

    query @@ -74439,34 +63082,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns lag-interface
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    + Tags: + Network +
    +
    +
    +

    returns lag-interface

    + +
    +
    + + + + + + + + + + + - + - + @@ -74508,7 +63232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -74613,7 +63337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -74647,7 +63371,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated.

    +

    lag-interface object that needs to be updated.

    @@ -74718,7 +63442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -74827,7 +63551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -74901,233 +63625,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-id + vnf-id -

    ID of interface

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - interface-role + interface-name -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Name that identifies the link aggregate interface

    querypath string +
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role + interface-name -

    role in the network that this model will be providing

    query @@ -75139,10 +63639,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + interface-id -

    string assigned to this model used for naming purposes

    query @@ -75154,10 +63653,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + macaddr -

    ID of interface

    query @@ -75169,10 +63667,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + network-name -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    query @@ -75221,7 +63718,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -75309,334 +63806,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    @@ -75676,7 +63845,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -75797,7 +63966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -75831,7 +64000,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated.

    +

    l-interface object that needs to be updated.

    @@ -75918,7 +64087,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -76043,7 +64212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -76147,379 +64316,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -76559,7 +64355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -76696,7 +64492,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -76730,7 +64526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -76833,7 +64629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -76974,7 +64770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -77111,7 +64907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -77236,7 +65032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -77340,379 +65136,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -77752,7 +65175,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -77889,7 +65312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -77923,7 +65346,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -78026,7 +65449,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78167,7 +65590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78304,7 +65727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78429,7 +65852,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78550,7 +65973,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78659,7 +66082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -78749,70 +66172,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone + pci-id -

    Regional way of organizing pservers, source of truth should define values

    query @@ -78824,10 +66186,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vf-vlan-filter -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -78839,10 +66200,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - heat-stack-id + vf-mac-filter -

    Heat stack id corresponding to this instance, managed by MSO

    query @@ -78854,21 +66214,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled + vf-vlan-strip @@ -78882,190 +66228,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name + neutron-network-id -

    Name of the network

    query @@ -79114,7 +66279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -79146,464 +66311,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + - + - + - + - + @@ -79645,7 +66422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -79782,7 +66559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -79816,7 +66593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated.

    +

    sriov-vf object that needs to be updated.

    @@ -79919,7 +66696,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -80060,7 +66837,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -80197,7 +66974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -80322,7 +67099,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -80412,293 +67189,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -
    path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -
    path - string - - - -
    - interface-name - -

    Name given to the interface

    -
    path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -
    path - string - - - -
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vf-vlan-filter + vnf-id -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - vf-mac-filter + interface-name -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Name that identifies the link aggregate interface

    querypath string +
    - vf-vlan-strip + interface-name -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    +

    Name given to the interface

    querypath - boolean + string +
    - neutron-network-id + pci-id -

    Neutron network id of the interface

    +

    PCI ID used to identify the sriov-vf

    querypath string +
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id + vlan-interface -

    ID of interface

    query @@ -80710,14 +67203,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    query - string + integer @@ -80725,10 +67217,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-key -

    Name of the network

    query @@ -80777,7 +67268,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -80881,364 +67372,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -
    query - string - - -
    - interface-id - -

    ID of interface

    -
    query - string - - -
    - macaddr - -

    MAC address for the interface

    -
    query - string - - -
    - network-name - -

    Name of the network

    -
    query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -
    query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -
    query - string - - -
    @@ -81278,7 +67411,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -81415,7 +67548,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -81449,7 +67582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated.

    +

    vlan object that needs to be updated.

    @@ -81552,7 +67685,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -81693,7 +67826,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -81813,409 +67946,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -82255,7 +67985,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -82408,7 +68138,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -82442,7 +68172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    l3-interface-ipv4-address-list object that needs to be updated.

    @@ -82561,7 +68291,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -82718,7 +68448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -82871,7 +68601,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -83012,7 +68742,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -83132,409 +68862,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - interface-role - - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    - - query - - string - - - - - - - - interface-id - - -

    ID of interface

    - - query - - string - - - - - - - - macaddr - - -

    MAC address for the interface

    - - query - - string - - - - - - - - network-name - - -

    Name of the network

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - vpn-key - - -

    This indicates the customers VPN ID associated with this vlan

    - - query - - string - - - - - - - - vlan-id-inner - - -

    Inner VLAN tag

    - - query - - integer - - - - - - - - neutron-network-id - - -

    Neutron network id of the interface that address belongs to

    - - query - - string - - - - - - - - neutron-subnet-id - - -

    Neutron id of subnet that address belongs to

    - - query - - string - - - - - @@ -83574,7 +68901,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -83727,7 +69054,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -83761,7 +69088,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    l3-interface-ipv6-address-list object that needs to be updated.

    @@ -83880,7 +69207,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84037,7 +69364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84190,7 +69517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84331,7 +69658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84468,7 +69795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84593,7 +69920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84698,7 +70025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84791,7 +70118,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -84849,233 +70176,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role + group-uuid -

    role in the network that this model will be providing

    query @@ -85087,10 +70190,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - nf-naming-code + resource-uuid -

    string assigned to this model used for naming purposes

    query @@ -85139,7 +70241,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -85227,259 +70329,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone - - -

    Regional way of organizing pservers, source of truth should define values

    - - query - - string - - - - - - - - prov-status - - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    - - query - - string - - - - - - - - nf-naming-code - - -

    string assigned to this model used for naming purposes

    - - query - - string - - - - - @@ -85519,7 +70368,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -85640,7 +70489,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -85674,7 +70523,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    license object that needs to be created or updated.

    +

    license object that needs to be updated.

    @@ -85761,7 +70610,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -85886,7 +70735,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86007,7 +70856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86116,7 +70965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86205,7 +71054,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86282,7 +71131,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86340,70 +71189,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

    Name of VNF.

    - - query - - string - - - - - - - - vnf-name2 - - -

    Alternate name of VNF.

    - - query - - string - - - - - - - - vnf-type - - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - regional-resource-zone + vf-module-id -

    Regional way of organizing pservers, source of truth should define values

    query @@ -86415,10 +71203,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vf-module-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    query @@ -86433,7 +71220,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

    Heat stack id corresponding to this instance, managed by MSO

    query @@ -86443,40 +71229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - model-invariant-id -

    the ASDC model id for this resource or service model.

    query @@ -86491,7 +71248,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

    the ASDC model version for this resource or service model.

    query @@ -86506,7 +71262,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -86521,52 +71276,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - - - - - nf-type - - -

    Generic description of the type of NF

    - - query - - string - - - - - - - - nf-function - - -

    English description of Network function that the specific VNF deployment is providing

    - - query - - string - - - - - - - - nf-role - - -

    role in the network that this model will be providing

    query @@ -86578,10 +71287,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - nf-naming-code + contrail-service-instance-fqdn -

    string assigned to this model used for naming purposes

    query @@ -86630,7 +71338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -86702,362 +71410,237 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing vf-module
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    + Tags: + Network +
    +
    +
    +

    create or update an existing vf-module

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    +

    +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + +
    - vnf-name - -

    Name of VNF.

    -
    query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -
    query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -
    query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -
    query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -
    query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -
    query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -
    query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -
    query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -
    query - string - - -
    - vf-module-name - -

    Name of vf-module

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance.

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id + vnf-id -

    the ASDC model version for this resource or service model.

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - widget-model-id + vf-module-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Unique ID of vf-module.

    querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing vf-module
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    + Tags: + Network +
    +
    +
    +

    update an existing vf-module

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    vf-module object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + - + - + @@ -87069,29 +71652,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -87099,7 +71659,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87115,34 +71675,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing vf-module
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    delete an existing vf-module
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    create or update an existing vf-module

    +

    delete an existing vf-module

    application/json application/xml

    -
    -
    -

    vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    -

    -
    -
    -
    - -
    -
    - widget-model-version + vnf-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Unique id of VNF. This is unique across the graph.

    querypath string +
    - contrail-service-instance-fqdn + vf-module-id -

    the Contrail unique ID for a service-instance

    +

    Unique ID of vf-module.

    querypath string +
    @@ -87188,6 +71736,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -87204,7 +71768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87219,17 +71783,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    update an existing vf-module
    -

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    Tags: Network
    -

    update an existing vf-module

    +

    see node definition for valid relationships

    @@ -87238,13 +71802,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vf-module object that needs to be created or updated.

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    @@ -87309,7 +71873,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87324,17 +71888,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vf-module
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing vf-module

    +

    delete an existing relationship

    @@ -87386,22 +71950,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

    resource-version for concurrency

    - - query - - string - - - - - -
    @@ -87418,7 +71966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87433,36 +71981,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    +
    returns instance-groups
    +

    GET /network/instance-groups

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns instance-groups

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    -

    -
    -
    -
    - -
    -
    -
    @@ -87477,174 +72008,64 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - vnf-id + id -

    Unique id of VNF. This is unique across the graph.

    pathquery string -
    - vf-module-id + description -

    Unique ID of vf-module.

    pathquery string -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - +
    - vnf-id + type -

    Unique id of VNF. This is unique across the graph.

    pathquery string -
    - vf-module-id + sub-type -

    Unique ID of vf-module.

    pathquery string -
    -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns instance-groups
    -

    GET /network/instance-groups

    - Tags: - Network -
    -
    -
    -

    returns instance-groups

    - -
    -

    application/json application/xml

    @@ -87680,7 +72101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87736,51 +72157,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - description - - -

    Descriptive text to help identify the usage of this instance-group

    - - query - - string - - - - - - - - type - - -

    Only valid value today is lower case ha for high availability

    - - query - - string - - - - - - - - sub-type - - -

    Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

    - - query - - string - - - - -
    @@ -87820,7 +72196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87909,7 +72285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -87943,7 +72319,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    instance-group object that needs to be created or updated.

    +

    instance-group object that needs to be updated.

    @@ -87998,7 +72374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88091,7 +72467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88180,7 +72556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88257,7 +72633,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88285,6 +72661,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns ipsec-configurations

    +
    + + + + + + + + + + + + + + + + + + + +
    + ipsec-configuration-id + + query + string + + +
    +

    application/json application/xml @@ -88321,7 +72726,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88416,7 +72821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88505,7 +72910,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88539,7 +72944,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ipsec-configuration object that needs to be created or updated.

    +

    ipsec-configuration object that needs to be updated.

    @@ -88594,7 +72999,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88687,7 +73092,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88776,7 +73181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88853,7 +73258,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -88909,6 +73314,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + vig-address-type + + + + query + + string + + + + +
    @@ -88948,7 +73367,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89059,7 +73478,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89164,7 +73583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89198,7 +73617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vig-server object that needs to be created or updated.

    +

    vig-server object that needs to be updated.

    @@ -89269,7 +73688,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89378,7 +73797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89483,7 +73902,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89576,7 +73995,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89603,70 +74022,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns l3-networks

    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns l3-network
    -

    GET /network/l3-networks/l3-network/{network-id}

    - Tags: - Network -
    -
    -
    -

    returns l3-network

    -
    @@ -89685,15 +74040,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-id - + @@ -89701,7 +74054,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name
    -

    Network ID, should be uuid. Unique across A&AI.

    pathquery string -
    -

    Name of the network, governed by some naming convention..

    query @@ -89716,7 +74068,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-role -

    Role the network plans - who defines these values?

    query @@ -89731,7 +74082,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    query @@ -89746,7 +74096,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

    Heat stack id corresponding to this instance, managed by MSO

    query @@ -89761,7 +74110,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen contrail-network-fqdn -

    Contrail FQDN for the network

    query @@ -89776,7 +74124,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id -

    the ASDC model id for this resource or service model.

    query @@ -89791,7 +74138,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

    the ASDC model version for this resource or service model.

    query @@ -89806,7 +74152,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -89821,7 +74166,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query @@ -89835,6 +74179,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-network
    +

    GET /network/l3-networks/l3-network/{network-id}

    + Tags: + Network +
    +
    +
    +

    returns l3-network

    + +
    +
    + + + + + + + + + + + + + + + + + + + +
    + network-id + +

    Network ID, should be uuid. Unique across A&AI.

    +
    path + string + + + +
    +
    +

    application/json application/xml

    @@ -89870,7 +74309,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89959,7 +74398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -89993,7 +74432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-network object that needs to be created or updated.

    +

    l3-network object that needs to be updated.

    @@ -90048,7 +74487,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90141,7 +74580,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90199,134 +74638,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name - - -

    Name of the network, governed by some naming convention..

    - - query - - string - - - - - - - - network-role - - -

    Role the network plans - who defines these values?

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - contrail-network-fqdn - - -

    Contrail FQDN for the network

    - - query - - string - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version + vlan-id-inner -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query - string + integer @@ -90371,7 +74689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90443,141 +74761,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - network-name - - -

    Name of the network, governed by some naming convention..

    - - query - - string - - - - - - - - network-role - - -

    Role the network plans - who defines these values?

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - contrail-network-fqdn - - -

    Contrail FQDN for the network

    - - query - - string - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id - - -

    the ASDC model version for this resource or service model.

    - - query - - string - - - - - - - - widget-model-id - - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    - - query - - string - - - - - - - - widget-model-version - - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    - - query - - string - - - - -
    @@ -90617,7 +74800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90722,7 +74905,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90756,7 +74939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-assignment object that needs to be created or updated.

    +

    ctag-assignment object that needs to be updated.

    @@ -90827,7 +75010,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -90936,7 +75119,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91041,7 +75224,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91134,7 +75317,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91223,7 +75406,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91300,7 +75483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91327,236 +75510,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    returns segmentation-assignments

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - network-id - -

    Network ID, should be uuid. Unique across A&AI.

    -
    path - string - - - -
    - network-name - -

    Name of the network, governed by some naming convention..

    -
    query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -
    query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - - - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns segmentation-assignment
    -

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    - Tags: - Network -
    -
    -
    -

    returns segmentation-assignment

    -
    @@ -91591,113 +75544,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen segmentation-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    -

    Route Table Reference id, UUID assigned to this instance.

    -
    path - string - - - -
    - network-name - -

    Name of the network, governed by some naming convention..

    -
    query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -
    query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    query @@ -91707,34 +75553,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + + + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns segmentation-assignment
    +

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    + Tags: + Network +
    +
    +
    +

    returns segmentation-assignment

    + +
    +
    + + + + + + + + + + + - + - + @@ -91776,7 +75703,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91881,7 +75808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -91915,7 +75842,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    segmentation-assignment object that needs to be created or updated.

    +

    segmentation-assignment object that needs to be updated.

    @@ -91986,7 +75913,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92095,7 +76022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92200,7 +76127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92293,7 +76220,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92351,115 +76278,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - widget-model-id + network-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Network ID, should be uuid. Unique across A&AI.

    querypath string +
    - widget-model-version + segmentation-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Route Table Reference id, UUID assigned to this instance.

    querypath string +
    - network-name - -

    Name of the network, governed by some naming convention..

    -
    query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -
    query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id + subnet-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    query @@ -92471,10 +76292,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + subnet-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    query @@ -92523,7 +76343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92595,156 +76415,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name - -

    Name of the network, governed by some naming convention..

    -
    query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -
    query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    query - string - - -
    - subnet-name - -

    Name associated with the subnet.

    -
    query - string - - -
    @@ -92784,7 +76454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92889,7 +76559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -92923,7 +76593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    subnet object that needs to be created or updated.

    +

    subnet object that needs to be updated.

    @@ -92994,7 +76664,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93103,7 +76773,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93177,100 +76847,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name - - -

    Name of the network, governed by some naming convention..

    - - query - - string - - - - - - - - network-role - - -

    Role the network plans - who defines these values?

    - - query - - string - - - - - - - - service-id - - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    - - query - - string - - - - - - - - heat-stack-id - - -

    Heat stack id corresponding to this instance, managed by MSO

    - - query - - string - - - - - - - - contrail-network-fqdn - - -

    Contrail FQDN for the network

    - - query - - string - - - - - - - - model-invariant-id - - -

    the ASDC model id for this resource or service model.

    - - query - - string - - - - - - - - model-version-id + host-route-id -

    the ASDC model version for this resource or service model.

    query @@ -93280,49 +76859,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + + +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns host-route
    +

    GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    + Tags: + Network +
    +
    +
    +

    returns host-route

    + +
    +
    + + + + + + + + + + + - + - + - + @@ -93351,7 +77012,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -93364,7 +77025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93380,18 +77041,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns host-route
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    create or update an existing host-route
    +

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    Tags: Network
    -

    returns host-route

    +

    create or update an existing host-route

    +
    + +

    application/json application/xml +

    +
    +
    +

    host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

    +

    +
    +
    +
    + +
    +
    +
    - widget-model-id + network-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Network ID, should be uuid. Unique across A&AI.

    querypath string +
    - widget-model-version + subnet-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Subnet ID, should be UUID.

    querypath string +
    - subnet-name + host-route-id -

    Name associated with the subnet.

    +

    host-route id

    querypath string +
    @@ -93452,154 +77130,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing host-route
    +

    PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    + Tags: + Network +
    +
    +
    +

    update an existing host-route

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    host-route object that needs to be updated.

    +

    +
    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -93611,29 +77260,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - - -
    -
    - -
    default @@ -93641,7 +77267,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93657,34 +77283,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing host-route
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    delete an existing host-route
    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    Tags: Network
    -

    create or update an existing host-route

    +

    delete an existing host-route

    application/json application/xml

    -
    -
    -

    host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

    -

    -
    -
    -
    - -
    -
    - network-name - -

    Name of the network, governed by some naming convention..

    -
    query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -
    query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -
    query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -
    query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -
    query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -
    query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -
    query - string - - -
    - widget-model-id + network-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Network ID, should be uuid. Unique across A&AI.

    querypath string +
    - widget-model-version + subnet-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Subnet ID, should be UUID.

    querypath string +
    - subnet-name + host-route-id -

    Name associated with the subnet.

    +

    host-route id

    querypath string +
    @@ -93746,6 +77360,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +
    query + string + + + +
    @@ -93762,7 +77392,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93777,17 +77407,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    update an existing host-route
    -

    PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    see node definition for valid relationships
    +

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

    Tags: Network
    -

    update an existing host-route

    +

    see node definition for valid relationships

    @@ -93796,13 +77426,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    host-route object that needs to be created or updated.

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

    @@ -93883,7 +77513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -93898,17 +77528,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing host-route
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    delete an existing relationship
    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing host-route

    +

    delete an existing relationship

    @@ -93976,22 +77606,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

    resource-version for concurrency

    - - query - - string - - - - - -
    @@ -94008,7 +77622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -94023,11 +77637,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

    +

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    Tags: Network
    @@ -94042,7 +77656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

    @@ -94097,22 +77711,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - host-route-id - - -

    host-route id

    - - path - - string - - - - - - @@ -94129,7 +77727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -94144,11 +77742,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    Tags: Network
    @@ -94206,22 +77804,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - host-route-id - - -

    host-route id

    - - path - - string - - - - - - @@ -94238,7 +77820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Response codes found in response codes.

    +

    Response codes found in response codes.

    @@ -94253,36 +77835,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + + - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - +
    - network-id - -

    Network ID, should be uuid. Unique across A&AI.

    -
    path - string - - - -
    - subnet-id + link-name -

    Subnet ID, should be UUID.

    pathquery string -
    -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - - - - - - -