From 6b98bb3ec93a0bbfbe0e660cabc69978b53bfee8 Mon Sep 17 00:00:00 2001 From: Venkata Harish K Kajur Date: Thu, 18 Jan 2018 00:47:09 -0500 Subject: Sync the latest code changes Issue-ID: AAI-493 Change-Id: I5f39ce9bb19cfb9607b659bed82066cae7569ecc Signed-off-by: Venkata Harish K Kajur --- .gitignore | 1 + aai-core/.classpath | 33 +- aai-core/pom.xml | 22 +- .../java/org/onap/aai/audit/ListEndpoints.java | 8 +- .../java/org/onap/aai/db/props/AAIProperties.java | 1 + .../main/java/org/onap/aai/db/schema/AuditOXM.java | 3 +- .../java/org/onap/aai/db/schema/ScriptDriver.java | 20 +- .../main/java/org/onap/aai/dbgen/DataGrooming.java | 516 +- .../onap/aai/dbgen/DynamicPayloadGenerator.java | 498 + .../main/java/org/onap/aai/dbgen/GenTester.java | 18 +- .../java/org/onap/aai/dbgen/SchemaGenerator.java | 3 +- .../src/main/java/org/onap/aai/dbmap/AAIGraph.java | 29 +- .../java/org/onap/aai/dbmap/AAIGraphConfig.java | 107 + .../java/org/onap/aai/dbmap/InMemoryGraph.java | 106 + .../onap/aai/dmaap/AAIDmaapEventJMSConsumer.java | 17 + .../onap/aai/dmaap/AAIDmaapEventJMSProducer.java | 3 +- .../aai/extensions/OrphanLInterfaceHandler.java | 112 + .../org/onap/aai/introspection/Introspector.java | 3 +- .../onap/aai/introspection/IntrospectorWalker.java | 7 +- .../org/onap/aai/introspection/ModelInjestor.java | 2 +- .../org/onap/aai/introspection/MoxyLoader.java | 5 +- .../org/onap/aai/introspection/PojoLoader.java | 3 +- .../onap/aai/introspection/tools/CreateUUID.java | 29 +- .../org/onap/aai/logging/EcompErrorCategory.java | 44 + .../org/onap/aai/logging/EcompPatternLayout.java | 3 + .../org/onap/aai/logging/EcompResponseCode.java | 40 + .../onap/aai/logging/EcompResponseDescription.java | 46 + .../java/org/onap/aai/logging/ErrorLogHelper.java | 31 +- .../java/org/onap/aai/logging/LogFormatTools.java | 76 + .../java/org/onap/aai/logging/LoggingContext.java | 21 +- .../main/java/org/onap/aai/logging/StopWatch.java | 13 +- .../onap/aai/parsers/query/LegacyQueryParser.java | 4 +- .../aai/parsers/uri/URIToExtensionInformation.java | 9 +- .../aai/parsers/uri/URIToRelationshipObject.java | 1 - .../aai/query/builder/GraphTraversalBuilder.java | 55 + .../aai/query/builder/GremlinQueryBuilder.java | 73 +- .../org/onap/aai/query/builder/QueryBuilder.java | 30 + .../java/org/onap/aai/rest/RestHandlerService.java | 46 + .../main/java/org/onap/aai/rest/db/HttpEntry.java | 187 +- .../main/java/org/onap/aai/restcore/RESTAPI.java | 131 +- .../org/onap/aai/restcore/util/EdgeRuleBean.java | 95 + .../onap/aai/restcore/util/GenerateEdgeRules.java | 204 +- .../onap/aai/serialization/db/DBSerializer.java | 373 +- .../onap/aai/serialization/db/EdgeProperty.java | 15 +- .../org/onap/aai/serialization/db/EdgeRule.java | 47 +- .../org/onap/aai/serialization/db/EdgeRules.java | 23 +- .../serialization/db/InMemoryGraphSingleton.java | 60 + .../exceptions/MultipleEdgeRuleFoundException.java | 14 +- .../serialization/engines/InMemoryDBEngine.java | 207 + .../engines/query/GraphTraversalQueryEngine.java | 19 +- .../serialization/engines/query/QueryEngine.java | 6 +- .../serialization/queryformats/FormatFactory.java | 3 - .../serialization/queryformats/FormatMapper.java | 2 +- .../aai/serialization/queryformats/Formatter.java | 29 +- .../java/org/onap/aai/tasks/ScheduledTasks.java | 9 +- .../org/onap/aai/util/AAIApiServerURLBase.java | 3 +- .../src/main/java/org/onap/aai/util/AAIConfig.java | 17 +- .../main/java/org/onap/aai/util/AAIConstants.java | 12 +- .../java/org/onap/aai/util/AAIRSyncUtility.java | 4 +- .../java/org/onap/aai/util/AAISystemExitUtil.java | 34 + .../java/org/onap/aai/util/AutoGenerateHtml.java | 67 + .../main/java/org/onap/aai/util/GenerateXsd.java | 1345 +- .../java/org/onap/aai/util/HttpsAuthClient.java | 2 +- .../org/onap/aai/util/HttpsAuthExternalClient.java | 150 + .../src/main/java/org/onap/aai/util/Request.java | 7 +- .../java/org/onap/aai/util/RestController.java | 469 + .../org/onap/aai/util/StoreNotificationEvent.java | 12 +- .../org/onap/aai/util/UniquePropertyCheck.java | 30 +- .../org/onap/aai/util/swagger/GenerateSwagger.java | 26 +- .../resources/dbedgerules/DbEdgeRules_v10.json | 1918 +- .../resources/dbedgerules/DbEdgeRules_v11.json | 2206 +- .../resources/dbedgerules/DbEdgeRules_v12.json | 2980 +- .../main/resources/dbedgerules/DbEdgeRules_v8.json | 1592 +- .../main/resources/dbedgerules/DbEdgeRules_v9.json | 1840 +- aai-core/src/main/resources/edgeLabelMigration.csv | 212 + aai-core/src/main/resources/edgerulesTemplate.ftlh | 8 + aai-core/src/main/resources/ruleTemplate.ftlh | 12 + .../test/java/org/onap/aai/dbmap/AAIGraphTest.java | 79 + .../onap/aai/introspection/JSONStrategyTest.java | 136 + .../aai/introspection/PropertyPredicatesTest.java | 19 +- .../aai/introspection/sideeffect/DataCopyTest.java | 18 +- .../aai/introspection/sideeffect/DataLinkTest.java | 24 +- .../aai/introspection/tools/CreateUUIDTest.java | 91 + .../validation/IntrospectorValidationTest.java | 6 +- .../onap/aai/logging/EcompErrorCategoryTest.java | 50 + .../onap/aai/logging/EcompResponseCodeTest.java | 49 + .../aai/logging/EcompResponseDescriptionTest.java | 50 + .../org/onap/aai/logging/LoggingContextTest.java | 2 +- .../onap/aai/parsers/query/GraphTraversalTest.java | 46 +- .../onap/aai/parsers/query/UniqueURIQueryTest.java | 2 +- .../relationship/RelationshipToURITest.java | 16 +- .../org/onap/aai/parsers/uri/URIParserTest.java | 2 +- .../parsers/uri/URIToExtensionInformationTest.java | 2 +- .../query/builder/QueryBuilderTestAbstraction.java | 87 +- .../org/onap/aai/query/builder/SimplePathTest.java | 6 +- .../onap/aai/query/builder/TraversalQueryTest.java | 36 +- .../java/org/onap/aai/rest/CloudRegionTest.java | 76 + .../onap/aai/rest/GenericVnfLInterfaceTest.java | 78 + .../test/java/org/onap/aai/rest/TenantTest.java | 93 + .../java/org/onap/aai/rest/db/HttpEntryTest.java | 223 +- .../aai/serialization/db/DbSerializerTest.java | 497 +- .../onap/aai/serialization/db/EdgeRulesTest.java | 94 +- .../query/GraphTraversalQueryEngineTest.java | 13 +- .../serialization/queryformats/ConsoleTest.java | 83 + .../serialization/queryformats/GraphSONTest.java | 80 + .../serialization/queryformats/RawFormatTest.java | 4 +- .../queryformats/SimpleFormatTest.java | 1 - .../java/org/onap/aai/util/AAICSVWriterTest.java | 77 + .../util/AAIConfigCommandLinePropGetterTest.java | 105 + .../org/onap/aai/util/AAIRSyncUtilityTest.java | 55 + .../java/org/onap/aai/util/FileWatcherTest.java | 78 + .../java/org/onap/aai/util/GenerateXsdTest.java | 278 +- .../org/onap/aai/util/HbaseSaltPrefixerTest.java | 72 + .../java/org/onap/aai/util/KeyValueListTest.java | 76 + .../java/org/onap/aai/util/MapperUtilTest.java | 72 + .../test/java/org/onap/aai/util/PojoUtilsTest.java | 107 + .../java/org/onap/aai/util/RestURLEncoderTest.java | 63 + .../onap/aai/util/StoreNotificationEventTest.java | 235 + .../aai/workarounds/LegacyURITransformerTest.java | 104 + .../etc/appprops/aaiconfig.properties | 70 +- .../etc/appprops/error.properties | 8 +- .../bundleconfig-local/etc/oxm/aai_oxm_v10.xml | 11219 +- .../bundleconfig-local/etc/oxm/aai_oxm_v11.xml | 1332 +- .../bundleconfig-local/etc/oxm/aai_oxm_v12.xml | 743 +- .../bundleconfig-local/etc/oxm/aai_oxm_v2.xml | 1729 - .../bundleconfig-local/etc/oxm/aai_oxm_v8.xml | 4578 +- .../bundleconfig-local/etc/oxm/aai_oxm_v9.xml | 10760 +- .../etc/relationship/ambiguous-relationship.json | 6 +- .../etc/relationship/both-failv10-successv9.json | 6 +- .../etc/relationship/both-successv10-failv9.json | 4 +- .../etc/relationship/nothing-to-parse.json | 2 +- .../etc/relationship/only-related-link.json | 4 +- .../etc/relationship/only-relationship-data.json | 4 +- .../DbEdgeRules_TraversalQueryTest.json | 36 +- .../resources/dbedgerules/DbEdgeRules_test.json | 65 +- .../dbedgerules/DbEdgeRules_test_broken.json | 9 +- aai-core/src/test/resources/edgeLabelMigration.csv | 212 + aai-core/src/test/resources/logback.xml | 4 +- .../openecomp/aai/introspection/aai_oxm_v10.xml | 5796 - .../org/openecomp/aai/introspection/aai_oxm_v8.xml | 3079 - .../org/openecomp/aai/introspection/aai_oxm_v9.xml | 599 - .../expected/generic-vnf-with-lag-interface.json | 27 + .../resource/cloud-region-with-all-children.json | 310 + .../payloads/resource/l-interface-with-ipv6.json | 22 + .../resources/payloads/templates/cloud-region.json | 310 + .../templates/generic-vnf-with-lag-interface.json | 24 + .../test/resources/payloads/templates/tenant.json | 169 + aai-schema/.classpath | 4 +- .../main/resources/aai_schema/aai_schema_v12.xsd | 228 +- .../aai_swagger_html/aai_swagger_v12.html | 189965 ++++++++++++++++++ .../resources/aai_swagger_html/aai_swagger_v8.html | 21084 +- .../aai_swagger_yaml/aai_swagger_bulk_v12.yaml | 4 +- .../aai_swagger_yaml/aai_swagger_v12.yaml | 68563 +++++++ aai-schema/src/main/resources/oxm/aai_oxm_v12.xml | 204 +- docs/index.rst | 4 +- 155 files changed, 292637 insertions(+), 48239 deletions(-) create mode 100644 aai-core/src/main/java/org/onap/aai/dbgen/DynamicPayloadGenerator.java create mode 100644 aai-core/src/main/java/org/onap/aai/dbmap/AAIGraphConfig.java create mode 100644 aai-core/src/main/java/org/onap/aai/dbmap/InMemoryGraph.java create mode 100644 aai-core/src/main/java/org/onap/aai/extensions/OrphanLInterfaceHandler.java create mode 100644 aai-core/src/main/java/org/onap/aai/logging/EcompErrorCategory.java create mode 100644 aai-core/src/main/java/org/onap/aai/logging/EcompResponseCode.java create mode 100644 aai-core/src/main/java/org/onap/aai/logging/EcompResponseDescription.java create mode 100644 aai-core/src/main/java/org/onap/aai/rest/RestHandlerService.java create mode 100644 aai-core/src/main/java/org/onap/aai/restcore/util/EdgeRuleBean.java create mode 100644 aai-core/src/main/java/org/onap/aai/serialization/db/InMemoryGraphSingleton.java create mode 100644 aai-core/src/main/java/org/onap/aai/serialization/engines/InMemoryDBEngine.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/AAISystemExitUtil.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/AutoGenerateHtml.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/HttpsAuthExternalClient.java create mode 100644 aai-core/src/main/java/org/onap/aai/util/RestController.java create mode 100644 aai-core/src/main/resources/edgeLabelMigration.csv create mode 100644 aai-core/src/main/resources/edgerulesTemplate.ftlh create mode 100644 aai-core/src/main/resources/ruleTemplate.ftlh create mode 100644 aai-core/src/test/java/org/onap/aai/dbmap/AAIGraphTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/JSONStrategyTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/introspection/tools/CreateUUIDTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/logging/EcompErrorCategoryTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/logging/EcompResponseCodeTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/logging/EcompResponseDescriptionTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/rest/TenantTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/serialization/queryformats/ConsoleTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/serialization/queryformats/GraphSONTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/AAIConfigCommandLinePropGetterTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/AAIRSyncUtilityTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/FileWatcherTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/HbaseSaltPrefixerTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/KeyValueListTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/MapperUtilTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/PojoUtilsTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/RestURLEncoderTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java create mode 100644 aai-core/src/test/java/org/onap/aai/workarounds/LegacyURITransformerTest.java delete mode 100644 aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v2.xml create mode 100644 aai-core/src/test/resources/edgeLabelMigration.csv delete mode 100644 aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v10.xml delete mode 100644 aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v8.xml delete mode 100644 aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v9.xml create mode 100644 aai-core/src/test/resources/payloads/expected/generic-vnf-with-lag-interface.json create mode 100644 aai-core/src/test/resources/payloads/resource/cloud-region-with-all-children.json create mode 100644 aai-core/src/test/resources/payloads/resource/l-interface-with-ipv6.json create mode 100644 aai-core/src/test/resources/payloads/templates/cloud-region.json create mode 100644 aai-core/src/test/resources/payloads/templates/generic-vnf-with-lag-interface.json create mode 100644 aai-core/src/test/resources/payloads/templates/tenant.json create mode 100644 aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html create mode 100644 aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml diff --git a/.gitignore b/.gitignore index 5b160ae6..00b46098 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ bundleconfig-local/etc/auth/tomcat_keystore bundleconfig-local/etc/logback.xml /.pydevproject /bin/ +**/.idea/ */.idea *.iml .idea/ \ No newline at end of file diff --git a/aai-core/.classpath b/aai-core/.classpath index 7dcc5272..78a65b57 100644 --- a/aai-core/.classpath +++ b/aai-core/.classpath @@ -1,35 +1,18 @@ - + + + + + - - - - - - - - - - - - - - - - - - - - - - - + - + + diff --git a/aai-core/pom.xml b/aai-core/pom.xml index a93e2e6e..63a5d83b 100644 --- a/aai-core/pom.xml +++ b/aai-core/pom.xml @@ -154,6 +154,12 @@ commons-lang 2.6 + + org.apache.commons + commons-text + 1.1 + compile + com.att.eelf eelf-core @@ -454,7 +460,7 @@ 1.4.0 test - + @@ -484,6 +490,19 @@ + + post-unit-test + test + + report + + + + ${project.build.directory}/coverage-reports/jacoco.exec + + ${project.reporting.outputDirectory}/jacoco + + @@ -496,6 +515,7 @@ 2.12.4 -noverify ${argLine} + alphabetical . bundleconfig-local diff --git a/aai-core/src/main/java/org/onap/aai/audit/ListEndpoints.java b/aai-core/src/main/java/org/onap/aai/audit/ListEndpoints.java index 5ee973a3..bfa8748c 100644 --- a/aai-core/src/main/java/org/onap/aai/audit/ListEndpoints.java +++ b/aai-core/src/main/java/org/onap/aai/audit/ListEndpoints.java @@ -40,6 +40,8 @@ import org.onap.aai.introspection.LoaderFactory; import org.onap.aai.introspection.ModelType; import org.onap.aai.introspection.Version; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.logging.LogFormatTools; + import com.att.eelf.configuration.EELFLogger; import com.att.eelf.configuration.EELFManager; import com.google.common.base.CaseFormat; @@ -121,7 +123,7 @@ public class ListEndpoints { try { endpoints.add(currentUri + obj.getLoader().introspectorFromName(key).getGenericURI()); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping endpoint for " + key + " (Unknown object)", e); + LOGGER.warn("Skipping endpoint for " + key + " (Unknown object) " + LogFormatTools.getStackTop(e)); } } } @@ -147,7 +149,7 @@ public class ListEndpoints { newVisited ); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping nested endpoint for " + propName + " (Unknown Object)", e); + LOGGER.warn("Skipping nested endpoint for " + propName + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } } else if (obj.isComplexType(propName)) { @@ -161,7 +163,7 @@ public class ListEndpoints { visited ); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping nested enpoint for " + propName + " (Unknown Object)", e); + LOGGER.warn("Skipping nested enpoint for " + propName + " (Unknown Object) "+ LogFormatTools.getStackTop(e)); } } } diff --git a/aai-core/src/main/java/org/onap/aai/db/props/AAIProperties.java b/aai-core/src/main/java/org/onap/aai/db/props/AAIProperties.java index 76a13363..e26d930e 100644 --- a/aai-core/src/main/java/org/onap/aai/db/props/AAIProperties.java +++ b/aai-core/src/main/java/org/onap/aai/db/props/AAIProperties.java @@ -36,5 +36,6 @@ public class AAIProperties { public static final Integer MAXIMUM_DEPTH = 10000; public static final String LINKED = "linked"; public static final String DB_ALIAS_SUFFIX = "-local"; + public static final String AAI_UUID = "aai-uuid"; } diff --git a/aai-core/src/main/java/org/onap/aai/db/schema/AuditOXM.java b/aai-core/src/main/java/org/onap/aai/db/schema/AuditOXM.java index e64f3ea3..0a3650fa 100644 --- a/aai-core/src/main/java/org/onap/aai/db/schema/AuditOXM.java +++ b/aai-core/src/main/java/org/onap/aai/db/schema/AuditOXM.java @@ -47,6 +47,7 @@ import org.onap.aai.introspection.LoaderFactory; import org.onap.aai.introspection.ModelType; import org.onap.aai.introspection.Version; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.schema.enums.ObjectMetadata; import org.onap.aai.util.AAIConstants; import com.att.eelf.configuration.EELFLogger; @@ -77,7 +78,7 @@ public class AuditOXM extends Auditor { allObjects.add(temp); this.createDBProperties(temp); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping audit for object " + key + " (Unknown Object)", e); + LOGGER.warn("Skipping audit for object " + key + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } for (Introspector temp : allObjects) { diff --git a/aai-core/src/main/java/org/onap/aai/db/schema/ScriptDriver.java b/aai-core/src/main/java/org/onap/aai/db/schema/ScriptDriver.java index fc494883..968d9ef2 100644 --- a/aai-core/src/main/java/org/onap/aai/db/schema/ScriptDriver.java +++ b/aai-core/src/main/java/org/onap/aai/db/schema/ScriptDriver.java @@ -22,13 +22,17 @@ package org.onap.aai.db.schema; import java.io.IOException; +import java.util.UUID; +import org.apache.commons.configuration.ConfigurationException; import org.codehaus.jackson.JsonGenerationException; import org.codehaus.jackson.map.JsonMappingException; import org.codehaus.jackson.map.ObjectMapper; - +import org.onap.aai.dbmap.AAIGraphConfig; import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.Version; +import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; import org.onap.aai.util.AAIConfig; import com.beust.jcommander.JCommander; import com.beust.jcommander.Parameter; @@ -47,9 +51,19 @@ public class ScriptDriver { * @throws JsonMappingException the json mapping exception * @throws IOException Signals that an I/O exception has occurred. */ - public static void main (String[] args) throws AAIException, IOException { + public static void main (String[] args) throws AAIException, IOException, ConfigurationException { CommandLineArgs cArgs = new CommandLineArgs(); + LoggingContext.init(); + LoggingContext.component("DBSchemaScriptDriver"); + LoggingContext.partnerName("NA"); + LoggingContext.targetEntity("AAI"); + LoggingContext.requestId(UUID.randomUUID().toString()); + LoggingContext.serviceName("AAI"); + LoggingContext.targetServiceName("main"); + LoggingContext.statusCode(StatusCode.COMPLETE); + LoggingContext.responseCode(LoggingContext.SUCCESS); + new JCommander(cArgs, args); if (cArgs.help) { @@ -57,7 +71,7 @@ public class ScriptDriver { } String config = cArgs.config; AAIConfig.init(); - try (TitanGraph graph = TitanFactory.open(config)) { + try (TitanGraph graph = TitanFactory.open(new AAIGraphConfig.Builder(config).forService(ScriptDriver.class.getSimpleName()).withGraphType("NA").buildConfiguration())) { if (!("oxm".equals(cArgs.type) || "graph".equals(cArgs.type))) { System.out.println("type: " + cArgs.type + " not recognized."); System.exit(1); diff --git a/aai-core/src/main/java/org/onap/aai/dbgen/DataGrooming.java b/aai-core/src/main/java/org/onap/aai/dbgen/DataGrooming.java index afc7807b..f7b9d866 100644 --- a/aai-core/src/main/java/org/onap/aai/dbgen/DataGrooming.java +++ b/aai-core/src/main/java/org/onap/aai/dbgen/DataGrooming.java @@ -50,6 +50,7 @@ import org.apache.tinkerpop.gremlin.structure.Vertex; import org.apache.tinkerpop.gremlin.structure.VertexProperty; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.dbmap.AAIGraph; +import org.onap.aai.dbmap.AAIGraphConfig; import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.Introspector; import org.onap.aai.introspection.Loader; @@ -57,11 +58,13 @@ import org.onap.aai.introspection.LoaderFactory; import org.onap.aai.introspection.ModelType; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LogFormatTools; +import org.onap.aai.logging.LoggingContext; import org.onap.aai.serialization.db.AAIDirection; import org.onap.aai.serialization.db.EdgeProperty; -import org.onap.aai.util.AAIConfig; -import org.onap.aai.util.AAIConstants; -import org.onap.aai.util.FormatDate; +import org.onap.aai.util.*; +import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; import com.att.eelf.configuration.Configuration; import com.att.eelf.configuration.EELFLogger; @@ -83,8 +86,9 @@ public class DataGrooming { * @param args the arguments */ public static void main(String[] args) { - + // Set the logging file properties to be used by EELFManager + System.setProperty("aai.service.name", DataGrooming.class.getSimpleName()); Properties props = System.getProperties(); props.setProperty(Configuration.PROPERTY_LOGGING_FILE_NAME, AAIConstants.AAI_DATA_GROOMING_LOGBACK_PROPS); props.setProperty(Configuration.PROPERTY_LOGGING_FILE_PATH, AAIConstants.AAI_HOME_ETC_APP_PROPERTIES); @@ -102,9 +106,19 @@ public class DataGrooming { Boolean neverUseCache = false; Boolean skipEdgeCheckFlag = false; + LoggingContext.init(); + LoggingContext.partnerName(FROMAPPID); + LoggingContext.serviceName(AAIConstants.AAI_RESOURCES_MS); + LoggingContext.component("dataGrooming"); + LoggingContext.targetEntity(AAIConstants.AAI_RESOURCES_MS); + LoggingContext.targetServiceName("main"); + LoggingContext.requestId(TRANSID); + LoggingContext.statusCode(StatusCode.COMPLETE); + LoggingContext.responseCode(LoggingContext.SUCCESS); + int timeWindowMinutes = 0; // A value of 0 means that we will not have a time-window -- we will look // at all nodes of the passed-in nodeType. - long windowStartTime = 0; // Translation of the window into a starting timestamp + int maxRecordsToFix = AAIConstants.AAI_GROOMING_DEFAULT_MAX_FIX; int sleepMinutes = AAIConstants.AAI_GROOMING_DEFAULT_SLEEP_MINUTES; @@ -127,17 +141,9 @@ public class DataGrooming { dupeGrpsDeleted = 0; FormatDate fd = new FormatDate("yyyyMMddHHmm", "GMT"); String dteStr = fd.getDateTime(); - String groomOutFileName = "dataGrooming." + dteStr + ".out"; - String argString = ""; - for( int x = 0; x < args.length; x++ ) { - argString = argString + " " + args[x]; - } - LOGGER.info(" DataGrooming called with these options: [" + argString + "]"); - if (args.length > 0) { // They passed some arguments in that will affect processing - for (int i = 0; i < args.length; i++) { String thisArg = args[i]; if (thisArg.equals("-edgesOnly")) { @@ -165,76 +171,98 @@ public class DataGrooming { } else if (thisArg.equals("-maxFix")) { i++; if (i >= args.length) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error(" No value passed with -maxFix option. "); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } String nextArg = args[i]; try { maxRecordsToFix = Integer.parseInt(nextArg); } catch (Exception e) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error("Bad value passed with -maxFix option: [" + nextArg + "]"); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } } else if (thisArg.equals("-sleepMinutes")) { i++; if (i >= args.length) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error("No value passed with -sleepMinutes option."); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } String nextArg = args[i]; try { sleepMinutes = Integer.parseInt(nextArg); } catch (Exception e) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error("Bad value passed with -sleepMinutes option: [" + nextArg + "]"); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } } else if (thisArg.equals("-timeWindowMinutes")) { i++; if (i >= args.length) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error("No value passed with -timeWindowMinutes option."); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } String nextArg = args[i]; try { timeWindowMinutes = Integer.parseInt(nextArg); } catch (Exception e) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error("Bad value passed with -timeWindowMinutes option: [" + nextArg + "]"); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } - if( timeWindowMinutes > 0 ){ - // Translate the window value (ie. 30 minutes) into a unix timestamp like - // we use in the db - so we can select data created after that time. - windowStartTime = figureWindowStartTime( timeWindowMinutes ); - } + } else if (thisArg.equals("-f")) { i++; if (i >= args.length) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error(" No value passed with -f option. "); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } prevFileName = args[i]; } else { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error(" Unrecognized argument passed to DataGrooming: [" + thisArg + "]. "); - LOGGER.error(" Valid values are: -f -autoFix -maxFix -edgesOnly -dupeFixOn -donFixOrphans -sleepMinutes -neverUseCache"); - System.exit(0); + LOGGER.error(" Valid values are: -f -autoFix -maxFix -edgesOnly -skipEdgeChecks -dupeFixOn -donFixOrphans -timeWindowMinutes -sleepMinutes -neverUseCache"); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } } } - + String windowTag = "FULL"; + if( timeWindowMinutes > 0 ){ + windowTag = "PARTIAL"; + } + String groomOutFileName = "dataGrooming." + windowTag + "." + dteStr + ".out"; + try { LoaderFactory.createLoaderForVersion(ModelType.MOXY, AAIProperties.LATEST); } catch (Exception ex){ - LOGGER.error("ERROR - Could not create loader", ex); - System.exit(1); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); + LOGGER.error("ERROR - Could not create loader " + LogFormatTools.getStackTop(ex)); + AAISystemExitUtil.systemExitCloseAAIGraph(1); } + if (skipHostCheck) { + LOGGER.info(" We will skip the HostCheck as requested. "); + } try { if (!prevFileName.equals("")) { @@ -248,7 +276,7 @@ public class DataGrooming { maxRecordsToFix, groomOutFileName, ver, singleCommits, dupeCheckOff, dupeFixOn, ghost2CheckOff, ghost2FixOn, finalShutdownFlag, cacheDbOkFlag, - skipEdgeCheckFlag, windowStartTime); + skipEdgeCheckFlag, timeWindowMinutes); } else if (doAutoFix) { // They want us to run the processing twice -- first to look for // delete candidates, then after @@ -264,7 +292,7 @@ public class DataGrooming { dontFixOrphansFlag, maxRecordsToFix, groomOutFileName, ver, singleCommits, dupeCheckOff, dupeFixOn, ghost2CheckOff, ghost2FixOn, finalShutdownFlag, cacheDbOkFlag, - skipEdgeCheckFlag, windowStartTime); + skipEdgeCheckFlag, timeWindowMinutes); if (fixCandCount == 0) { LOGGER.info(" No fix-Candidates were found by the first pass, so no second/fix-pass is needed. "); } else { @@ -277,7 +305,7 @@ public class DataGrooming { Thread.sleep(sleepMsec); } catch (InterruptedException ie) { LOGGER.info("\n >>> Sleep Thread has been Interrupted <<< "); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); } dteStr = fd.getDateTime(); @@ -293,7 +321,7 @@ public class DataGrooming { secondGroomOutFileName, ver, singleCommits, dupeCheckOff, dupeFixOn, ghost2CheckOff, ghost2FixOn, finalShutdownFlag, cacheDbOkFlag, - skipEdgeCheckFlag, windowStartTime); + skipEdgeCheckFlag, timeWindowMinutes); } } else { // Do the grooming - plain vanilla (no fix-it-file, no @@ -309,14 +337,16 @@ public class DataGrooming { maxRecordsToFix, groomOutFileName, ver, singleCommits, dupeCheckOff, dupeFixOn, ghost2CheckOff, ghost2FixOn, finalShutdownFlag, cacheDbOkFlag, - skipEdgeCheckFlag, windowStartTime); + skipEdgeCheckFlag, timeWindowMinutes); } } catch (Exception ex) { - LOGGER.error("Exception while grooming data", ex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("Exception while grooming data " + LogFormatTools.getStackTop(ex)); } LOGGER.info(" Done! "); - System.exit(0); + AAISystemExitUtil.systemExitCloseAAIGraph(0); }// End of main() @@ -345,11 +375,12 @@ public class DataGrooming { Boolean dupeCheckOff, Boolean dupeFixOn, Boolean ghost2CheckOff, Boolean ghost2FixOn, Boolean finalShutdownFlag, Boolean cacheDbOkFlag, - Boolean skipEdgeCheckFlag, long windowStartTime) { + Boolean skipEdgeCheckFlag, int timeWindowMinutes) { LOGGER.debug(" Entering doTheGrooming \n"); int cleanupCandidateCount = 0; + long windowStartTime = 0; // Translation of the window into a starting timestamp BufferedWriter bw = null; TitanGraph graph = null; TitanGraph graph2 = null; @@ -360,6 +391,12 @@ public class DataGrooming { Graph g = null; Graph g2 = null; try { + if( timeWindowMinutes > 0 ){ + // Translate the window value (ie. 30 minutes) into a unix timestamp like + // we use in the db - so we can select data created after that time. + windowStartTime = figureWindowStartTime( timeWindowMinutes ); + } + AAIConfig.init(); String targetDir = AAIConstants.AAI_HOME + AAIConstants.AAI_FILESEP + "logs" + AAIConstants.AAI_FILESEP + "data" @@ -375,6 +412,8 @@ public class DataGrooming { } if (deleteCandidateList.size() > maxRecordsToFix) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(" >> WARNING >> Delete candidate list size (" + deleteCandidateList.size() + ") is too big. The maxFix we are using is: " @@ -404,10 +443,10 @@ public class DataGrooming { if( cacheDbOkFlag ){ // Since we're just reading (not deleting/fixing anything), we can use // a cached connection to the DB - graph = TitanFactory.open(AAIConstants.CACHED_DB_CONFIG); + graph = TitanFactory.open(new AAIGraphConfig.Builder(AAIConstants.CACHED_DB_CONFIG).forService(DataGrooming.class.getSimpleName()).withGraphType("cached").buildConfiguration()); } else { - graph = TitanFactory.open(AAIConstants.REALTIME_DB_CONFIG); + graph = TitanFactory.open(new AAIGraphConfig.Builder(AAIConstants.REALTIME_DB_CONFIG).forService(DataGrooming.class.getSimpleName()).withGraphType("realtime1").buildConfiguration()); } if (graph == null) { String emsg = "null graph object in DataGrooming\n"; @@ -448,12 +487,16 @@ public class DataGrooming { String nType = entry.getKey(); int thisNtCount = 0; int thisNtDeleteCount = 0; + LOGGER.debug(" > Look at : [" + nType + "] ..."); ntList = ntList + "," + nType; // Get a collection of the names of the key properties for this nodeType to use later - // Determine what the key fields are for this nodeType - Collection keyProps = entry.getValue().getKeys(); + // Determine what the key fields are for this nodeType - use an arrayList so they + // can be gotten out in a consistent order. + Set keyPropsSet = entry.getValue().getKeys(); + ArrayList keyProps = new ArrayList (); + keyProps.addAll(keyPropsSet); // Get the types of nodes that this nodetype depends on for uniqueness (if any) Collection depNodeTypes = loader.introspectorFromName(nType).getDependentOn(); @@ -477,12 +520,13 @@ public class DataGrooming { } Vertex thisVtx = iter.next(); if( windowStartTime > 0 ){ - // We only want nodes that are created after a passed-in timestamp - Object objTimeStamp = thisVtx.property("aai-created-ts").orElse(null); - if( objTimeStamp != null ){ - long thisNodeCreateTime = (long)objTimeStamp; - if( thisNodeCreateTime < windowStartTime ){ - // It is NOT in our window, so we can pass over it + // They are using the time-window, so we only want nodes that are updated after a + // passed-in timestamp OR that have no last-modified-timestamp which means they are suspicious. + Object objModTimeStamp = thisVtx.property("aai-last-mod-ts").orElse(null); + if( objModTimeStamp != null ){ + long thisNodeModTime = (long)objModTimeStamp; + if( thisNodeModTime < windowStartTime ){ + // It has a last modified ts and is NOT in our window, so we can pass over it continue; } } @@ -521,7 +565,9 @@ public class DataGrooming { boolean depNodeOk = true; if( depNodeTypes.isEmpty() ){ // This kind of node is not dependent on any other. - // Make sure we can get it back using it's key properties and that we only get one. + // Make sure we can get it back using it's key properties (that is the + // phantom checking) and that we only get one. Note - we also need + // to collect data for a second type of dupe-checking which is done later. secondGetList = getNodeJustUsingKeyParams( TRANSID, FROMAPPID, source1, nType, propHashWithKeys, version ); } @@ -556,7 +602,9 @@ public class DataGrooming { zeroEdges = true; } } catch (Exception ex) { - LOGGER.warn("WARNING from inside the for-each-vid-loop orphan-edges-check ", ex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.warn("WARNING from inside the for-each-vid-loop orphan-edges-check " + LogFormatTools.getStackTop(ex) ); } if (deleteCandidateList.contains(thisVid)) { @@ -568,7 +616,9 @@ public class DataGrooming { thisNtDeleteCount++; } catch (Exception e) { okFlag = false; - LOGGER.error("ERROR trying to delete missing-dep-node VID = " + thisVid, e); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("ERROR trying to delete missing-dep-node VID = " + thisVid + " " + LogFormatTools.getStackTop(e)); } if (okFlag) { LOGGER.info(" DELETED missing-dep-node VID = " + thisVid); @@ -605,7 +655,7 @@ public class DataGrooming { } } } - } + }// end of -- else this is a dependent node -- piece if( depNodeOk && (secondGetList == null || secondGetList.size() == 0) ){ // We could not get the node back using it's own key info. @@ -618,7 +668,9 @@ public class DataGrooming { thisNtDeleteCount++; } catch (Exception e) { okFlag = false; - LOGGER.error("ERROR trying to delete phantom VID = " + thisVid, e); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("ERROR trying to delete phantom VID = " + thisVid + " " + LogFormatTools.getStackTop(e)); } if (okFlag) { LOGGER.info(" DELETED VID = " + thisVid); @@ -644,21 +696,56 @@ public class DataGrooming { } } catch (AAIException e1) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(" For nodeType = " + nType + " Caught exception", e1); errArr.add(e1.getErrorObject().toString()); } catch (Exception e2) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(" For nodeType = " + nType + " Caught exception", e2); errArr.add(e2.getMessage()); } - }// try block to enclose looping of a single vertex + }// try block to enclose looping over each single vertex catch (Exception exx) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING from inside the while-verts-loop ", exx); } } // while loop for each record of a nodeType + if( depNodeTypes.isEmpty() && !dupeCheckOff ){ + // For this nodeType, we haven't looked at the possibility of a + // non-dependent node where two verts have same key info + ArrayList> nonDependentDupeSets = new ArrayList>(); + nonDependentDupeSets = getDupeSets4NonDepNodes( + TRANSID, FROMAPPID, g, + version, nType, tmpList, + keyProps, loader ); + // For each set found (each set is for a unique instance of key-values), + // process the dupes found + Iterator> dsItr = nonDependentDupeSets.iterator(); + while( dsItr.hasNext() ){ + ArrayList dupeList = dsItr.next(); + LOGGER.info(" - now check Dupes for some non-dependent guys - "); + List tmpDupeGroups = checkAndProcessDupes( + TRANSID, FROMAPPID, g, source1, version, + nType, dupeList, dupeFixOn, + deleteCandidateList, singleCommits, dupeGroups, loader); + Iterator dIter = tmpDupeGroups.iterator(); + while (dIter.hasNext()) { + // Add in any newly found dupes to our running list + String tmpGrp = dIter.next(); + LOGGER.info("Found set of dupes: [" + tmpGrp + "]"); + dupeGroups.add(tmpGrp); + } + } + + }// end of extra dupe check for non-dependent nodes + if ( (thisNtDeleteCount > 0) && singleCommits ) { // NOTE - the singleCommits option is not used in normal processing g.tx().commit(); @@ -669,6 +756,7 @@ public class DataGrooming { LOGGER.info( " Processed " + thisNtCount + " records for [" + nType + "], " + totalNodeCount + " total overall. " ); }// While-loop for each node type + }// end of check to make sure we weren't only supposed to do edges @@ -686,7 +774,7 @@ public class DataGrooming { LOGGER.debug(" ---- DEBUG --- about to open a SECOND graph (takes a little while)--------\n"); // Note - graph2 just reads - but we want it to use a fresh connection to // the database, so we are NOT using the CACHED DB CONFIG here. - graph2 = TitanFactory.open(AAIConstants.REALTIME_DB_CONFIG); + graph2 = TitanFactory.open(new AAIGraphConfig.Builder(AAIConstants.REALTIME_DB_CONFIG).forService(DataGrooming.class.getSimpleName()).withGraphType("realtime2").buildConfiguration()); if (graph2 == null) { String emsg = "null graph2 object in DataGrooming\n"; throw new AAIException("AAI_6101", emsg); @@ -718,6 +806,8 @@ public class DataGrooming { try { v = vItor2.next(); } catch (Exception vex) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get next vertex on the vItor2 "); continue; } @@ -727,6 +817,8 @@ public class DataGrooming { try { thisVertId = v.id().toString(); } catch (Exception ev) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING when doing getId() on a vertex from our vertex list. "); continue; } @@ -739,12 +831,13 @@ public class DataGrooming { } if( windowStartTime > 0 ){ - // We only want to look at nodes that are created after a passed-in timestamp - Object objTimeStamp = v.property("aai-created-ts").orElse(null); - if( objTimeStamp != null ){ - long thisNodeCreateTime = (long)objTimeStamp; - if( thisNodeCreateTime < windowStartTime ){ - // It is NOT in our window, so we can pass over it + // They are using the time-window, so we only want nodes that are updated after a + // passed-in timestamp OR that have no last-modified-timestamp which means they are suspicious. + Object objModTimeStamp = v.property("aai-last-mod-ts").orElse(null); + if( objModTimeStamp != null ){ + long thisNodeModTime = (long)objModTimeStamp; + if( thisNodeModTime < windowStartTime ){ + // It has a last modified ts and is NOT in our window, so we can pass over it continue; } } @@ -763,6 +856,8 @@ public class DataGrooming { try { e = eItor.next(); } catch (Exception iex) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get next edge on the eItor ", iex); continue; } @@ -770,6 +865,8 @@ public class DataGrooming { try { vIn = e.inVertex(); } catch (Exception err) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get edge's In-vertex ", err); } String vNtI = ""; @@ -795,6 +892,8 @@ public class DataGrooming { if( ! ghost2CheckOff ){ Vertex connectedVert = g2.traversal().V(vIdLong).next(); if( connectedVert == null ) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn( "GHOST2 -- got NULL when doing getVertex for vid = " + vIdLong); cantGetUsingVid = true; @@ -805,6 +904,8 @@ public class DataGrooming { ghost2 = g.traversal().V(vIdLong).next(); } catch( Exception ex){ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn( "GHOST2 -- Could not get the ghost info for a bad edge for vtxId = " + vIdLong, ex); } if( ghost2 != null ){ @@ -814,6 +915,8 @@ public class DataGrooming { }// end of the ghost2 checking } catch (Exception err) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get edge's In-vertex props ", err); } } @@ -841,6 +944,8 @@ public class DataGrooming { deleteCount++; } catch (Exception e1) { okFlag = false; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING when trying to delete bad-edge-connected VERTEX VID = " + vIdI, e1); } @@ -864,6 +969,8 @@ public class DataGrooming { // that this edge has already been // removed okFlag = false; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING when trying to delete edge = " + thisEid); } @@ -883,6 +990,8 @@ public class DataGrooming { try { vOut = e.outVertex(); } catch (Exception err) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get edge's Out-vertex "); } String vNtO = ""; @@ -915,6 +1024,8 @@ public class DataGrooming { ghost2 = g.traversal().V(vIdLong).next(); } catch( Exception ex){ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn( "GHOST2 -- Could not get the ghost info for a bad edge for vtxId = " + vIdLong, ex); } if( ghost2 != null ){ @@ -923,6 +1034,8 @@ public class DataGrooming { } } } catch (Exception err) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(">>> WARNING trying to get edge's Out-vertex props ", err); } } @@ -950,6 +1063,8 @@ public class DataGrooming { deleteCount++; } catch (Exception e1) { okFlag = false; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING when trying to delete bad-edge-connected VID = " + vIdO, e1); } @@ -973,6 +1088,8 @@ public class DataGrooming { // that this edge has already been // removed okFlag = false; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING when trying to delete edge = " + thisEid, ex); } @@ -990,6 +1107,8 @@ public class DataGrooming { } }// End of while-edges-loop } catch (Exception exx) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn("WARNING from in the while-verts-loop ", exx); } }// End of while-vertices-loop (the edge-checking) @@ -1004,7 +1123,9 @@ public class DataGrooming { executeFinalCommit = true; LOGGER.info("Commit was successful "); } catch (Exception excom) { - LOGGER.error(" >>>> ERROR <<<< Could not commit changes. ", excom); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error(" >>>> ERROR <<<< Could not commit changes. " + LogFormatTools.getStackTop(excom)); deleteCount = 0; } } @@ -1018,7 +1139,14 @@ public class DataGrooming { deleteCount = deleteCount + dupeGrpsDeleted; bw.write("\n\n ============ Summary ==============\n"); - bw.write("Ran these nodeTypes: " + ntList + "\n\n"); + if( timeWindowMinutes == 0 ){ + bw.write("Ran FULL data grooming (no time-window). \n"); + } + else { + bw.write("Ran PARTIAL data grooming just looking at data added/updated in the last " + timeWindowMinutes + " minutes. \n"); + } + + bw.write("\nRan these nodeTypes: " + ntList + "\n\n"); bw.write("There were this many delete candidates from previous run = " + deleteCandidateList.size() + "\n"); if (dontFixOrphansFlag) { @@ -1084,7 +1212,9 @@ public class DataGrooming { bw.write(info + "\n"); } } catch (Exception dex) { - LOGGER.error("error trying to print detail info for a ghost-node: ", dex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("error trying to print detail info for a ghost-node: " + LogFormatTools.getStackTop(dex)); } } @@ -1106,7 +1236,9 @@ public class DataGrooming { bw.write(info + "\n"); } } catch (Exception dex) { - LOGGER.error("error trying to print detail info for a Orphan Node /missing dependent edge", dex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("error trying to print detail info for a Orphan Node /missing dependent edge " + LogFormatTools.getStackTop(dex)); } } @@ -1129,7 +1261,10 @@ public class DataGrooming { bw.write(info + "\n"); } } catch (Exception dex) { - LOGGER.error("error trying to print detail info for a node missing its dependent edge but not an orphan", dex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("error trying to print detail info for a node missing its dependent edge but not an orphan " + + LogFormatTools.getStackTop(dex)); } } @@ -1149,7 +1284,9 @@ public class DataGrooming { + propKey.value() + "]\n"); } } catch (Exception pex) { - LOGGER.error("error trying to print empty/bad vertex data: ", pex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("error trying to print empty/bad vertex data: " + LogFormatTools.getStackTop(pex)); } } @@ -1228,7 +1365,9 @@ public class DataGrooming { }// else last entry }// for each vertex in a group } catch (Exception dex) { - LOGGER.error("error trying to print duplicate vertex data", dex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("error trying to print duplicate vertex data " + LogFormatTools.getStackTop(dex)); } }// while - work on each group of dupes @@ -1259,10 +1398,14 @@ public class DataGrooming { + "] and investigate delete candidates. "); } } catch (AAIException e) { - LOGGER.error("Caught AAIException while grooming data", e); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("Caught AAIException while grooming data"); ErrorLogHelper.logException(e); } catch (Exception ex) { - LOGGER.error("Caught exception while grooming data", ex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("Caught exception while grooming data"); ErrorLogHelper.logError("AAI_6128", ex.getMessage() + ", resolve and rerun dataGrooming"); } finally { @@ -1270,6 +1413,8 @@ public class DataGrooming { try { bw.close(); } catch (IOException iox) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); LOGGER.warn("Got an IOException trying to close bufferedWriter() \n", iox); } } @@ -1284,6 +1429,8 @@ public class DataGrooming { g.tx().rollback(); } catch (Exception ex) { // Don't throw anything because Titan sometimes is just saying that the graph is already closed + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); LOGGER.warn("WARNING from final graphTransaction.rollback()", ex); } } @@ -1295,6 +1442,8 @@ public class DataGrooming { g2.tx().rollback(); } catch (Exception ex) { // Don't throw anything because Titan sometimes is just saying that the graph is already closed + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); LOGGER.warn("WARNING from final graphTransaction2.rollback()", ex); } } @@ -1307,6 +1456,8 @@ public class DataGrooming { } } catch (Exception ex) { // Don't throw anything because Titan sometimes is just saying that the graph is already closed{ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); LOGGER.warn("WARNING from final graph.shutdown()", ex); } @@ -1317,6 +1468,8 @@ public class DataGrooming { } } catch (Exception ex) { // Don't throw anything because Titan sometimes is just saying that the graph is already closed{ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); LOGGER.warn("WARNING from final graph2.shutdown()", ex); } } @@ -1549,6 +1702,7 @@ public class DataGrooming { // (We'll check dep-node later) // Determine what the key fields are for this nodeType Collection keyProps = new ArrayList <>(); + HashMap keyPropValsHash = new HashMap (); try { keyProps = loader.introspectorFromName(vtxANodeType).getKeys(); } catch (AAIUnknownObjectException e) { @@ -1576,6 +1730,11 @@ public class DataGrooming { // data - so don't pick one return nullVtx; } + else { + // Keep these around for (potential) use later + keyPropValsHash.put(propName, vtxAKeyPropVal); + } + } // Collect the vid's and aai-node-types of the vertices that each vertex @@ -1618,18 +1777,20 @@ public class DataGrooming { } // 1 - If this kind of node needs a dependent node for uniqueness, then - // verify that they both nodes - // point to the same dependent node (otherwise they're not really - // duplicates) + // verify that they both nodes point to the same dependent + // node (otherwise they're not really duplicates) // Note - there are sometimes more than one dependent node type since - // one nodeType can be used in - // different ways. But for a particular node, it will only have one - // dependent node that it's - // connected to. - Collection depNodeTypes = loader.introspectorFromName(vtxANodeType).getDependentOn(); - + // one nodeType can be used in different ways. But for a + // particular node, it will only have one dependent node that + // it's connected to. + String onlyNodeThatIndexPointsToVidStr = ""; + Collection depNodeTypes = loader.introspectorFromName(vtxANodeType).getDependentOn(); if (depNodeTypes.isEmpty()) { // This kind of node is not dependent on any other. That is ok. + // We need to find out if the unique index info is good or not and + // use that later when deciding if we can delete one. + onlyNodeThatIndexPointsToVidStr = findJustOneUsingIndex( transId, + fromAppId, g, keyPropValsHash, vtxANodeType, vidA, vidB, ver ); } else { String depNodeVtxId4A = ""; String depNodeVtxId4B = ""; @@ -1654,8 +1815,11 @@ public class DataGrooming { } if (vtxIdsConn2A.size() == vtxIdsConn2B.size()) { - // 2 - If they both have edges to all the same vertices, then return - // the one with the lower vertexId. + // 2 - If they both have edges to all the same vertices, + // then return the one that can be reached uniquely via the + // key if that is the case or + // else the one with the lower vertexId + boolean allTheSame = true; Iterator iter = vtxIdsConn2A.iterator(); while (iter.hasNext()) { @@ -1667,7 +1831,19 @@ public class DataGrooming { } if (allTheSame) { - if (vidA < vidB) { + // If everything is the same, but one of the two has a good + // pointer to it, then save that one. Otherwise, take the + // older one. + if( !onlyNodeThatIndexPointsToVidStr.equals("") ){ + // only one is reachable via the index - choose that one. + if( onlyNodeThatIndexPointsToVidStr.equals(vidA.toString()) ){ + preferredVtx = vtxA; + } + else if( onlyNodeThatIndexPointsToVidStr.equals(vidB.toString()) ){ + preferredVtx = vtxB; + } + } + else if (vidA < vidB) { preferredVtx = vtxA; } else { preferredVtx = vtxB; @@ -1675,7 +1851,8 @@ public class DataGrooming { } } else if (vtxIdsConn2A.size() > vtxIdsConn2B.size()) { // 3 - VertexA is connected to more things than vtxB. - // We'll pick VtxA if its edges are a superset of vtxB's edges. + // We'll pick VtxA if its edges are a superset of vtxB's edges + // and it doesn't contradict the check for the index/key pointer. boolean missingOne = false; Iterator iter = vtxIdsConn2B.iterator(); while (iter.hasNext()) { @@ -1686,11 +1863,15 @@ public class DataGrooming { } } if (!missingOne) { - preferredVtx = vtxA; + if( onlyNodeThatIndexPointsToVidStr.equals("") + || onlyNodeThatIndexPointsToVidStr.equals(vidA.toString()) ){ + preferredVtx = vtxA; + } } } else if (vtxIdsConn2B.size() > vtxIdsConn2A.size()) { // 4 - VertexB is connected to more things than vtxA. - // We'll pick VtxB if its edges are a superset of vtxA's edges. + // We'll pick VtxB if its edges are a superset of vtxA's edges + // and it doesn't contradict the check for the index/key pointer. boolean missingOne = false; Iterator iter = vtxIdsConn2A.iterator(); while (iter.hasNext()) { @@ -1701,7 +1882,10 @@ public class DataGrooming { } } if (!missingOne) { - preferredVtx = vtxB; + if( onlyNodeThatIndexPointsToVidStr.equals("") + || onlyNodeThatIndexPointsToVidStr.equals(vidB.toString()) ){ + preferredVtx = vtxB; + } } } else { preferredVtx = nullVtx; @@ -1724,7 +1908,6 @@ public class DataGrooming { * @param deleteCandidateList the delete candidate list * @param singleCommits the single commits * @param alreadyFoundDupeGroups the already found dupe groups - * @param dbMaps the db maps * @return the array list */ private static List checkAndProcessDupes(String transId, @@ -1880,6 +2063,8 @@ public class DataGrooming { } } } catch (Exception e) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.warn(" >>> Threw an error in checkAndProcessDupes - just absorb this error and move on. ", e); } @@ -1896,7 +2081,6 @@ public class DataGrooming { * @param version the version * @param nType the n type * @param passedVertList the passed vert list - * @param dbMaps the db maps * @return the hash map * @throws AAIException the AAI exception */ @@ -2007,6 +2191,8 @@ public class DataGrooming { // like, "KeepVid=12345" String[] prefArr = prefString.split("="); if (prefArr.length != 2 || (!prefArr[0].equals("KeepVid"))) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.error("Bad format. Expecting KeepVid=999999"); return false; } else { @@ -2035,7 +2221,9 @@ public class DataGrooming { } } catch (Exception e) { okFlag = false; - LOGGER.error("ERROR trying to delete VID = " + thisVid, e); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error("ERROR trying to delete VID = " + thisVid + " " + LogFormatTools.getStackTop(e)); } if (okFlag) { LOGGER.info(" DELETED VID = " + thisVid); @@ -2044,6 +2232,8 @@ public class DataGrooming { } } } else { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); LOGGER.error("ERROR - Vertex Id to keep not found in list of dupes. dupeInfoString = [" + dupeInfoString + "]"); return false; @@ -2123,7 +2313,9 @@ public class DataGrooming { } } catch( Exception ex ){ - LOGGER.error( " ERROR trying to get node for: [" + propsAndValuesForMsg + "]", ex); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); + LOGGER.error( " ERROR trying to get node for: [" + propsAndValuesForMsg + "]" + LogFormatTools.getStackTop(ex)); } if( verts != null ){ @@ -2290,7 +2482,7 @@ public class DataGrooming { Vertex parentVtx = null; Iterator vertI = g.V(startVtx).union(__.inE().has(EdgeProperty.CONTAINS.toString(), AAIDirection.OUT.toString()).outV(), __.outE().has(EdgeProperty.CONTAINS.toString(), AAIDirection.IN.toString()).inV()); - + while( vertI != null && vertI.hasNext() ){ // Note - there better only be one! parentVtx = vertI.next(); @@ -2317,4 +2509,146 @@ public class DataGrooming { } // End of figureWindowStartTime() + /** + * Collect Duplicate Sets for nodes that are NOT dependent on parent nodes. + * + * @param transId the trans id + * @param fromAppId the from app id + * @param g the g + * @param version the version + * @param nType the n type + * @param passedVertList the passed vert list + * @return the array list + */ + private static ArrayList> getDupeSets4NonDepNodes( String transId, + String fromAppId, Graph g, String version, String nType, + ArrayList passedVertList, + ArrayList keyPropNamesArr, + Loader loader ) { + + ArrayList> returnList = new ArrayList>(); + + // We've been passed a set of nodes that we want to check. + // They are all NON-DEPENDENT nodes of the same nodeType meaning that they should be + // unique in the DB based on their KEY DATA alone. So, if + // we group them by their key data - if any key has more than one + // vertex mapped to it, those vertices are dupes. + // + // When we find duplicates, we group them in an ArrayList (there can be + // more than one duplicate for one set of key data) + // Then these dupeSets are grouped up and returned. + // + + HashMap > keyVals2VidHash = new HashMap >(); + HashMap vtxHash = new HashMap (); + Iterator pItr = passedVertList.iterator(); + while (pItr.hasNext()) { + try { + Vertex tvx = pItr.next(); + String thisVid = tvx.id().toString(); + vtxHash.put(thisVid, tvx); + + // if there are more than one vertexId mapping to the same keyProps -- they are dupes + // we dont check till later since a set can contain more than 2. + String hKey = getNodeKeyValString( tvx, keyPropNamesArr ); + if( keyVals2VidHash.containsKey(hKey) ){ + // We've already seen this key + ArrayList tmpVL = (ArrayList )keyVals2VidHash.get(hKey); + tmpVL.add(thisVid); + keyVals2VidHash.put(hKey, tmpVL); + } + else { + // First time for this key + ArrayList tmpVL = new ArrayList (); + tmpVL.add(thisVid); + keyVals2VidHash.put(hKey, tmpVL); + } + } + catch (Exception e) { + LOGGER.warn(" >>> Threw an error in getDupeSets4NonDepNodes - just absorb this error and move on. ", e); + } + } + + for( Map.Entry> entry : keyVals2VidHash.entrySet() ){ + ArrayList vidList = entry.getValue(); + try { + if( !vidList.isEmpty() && vidList.size() > 1 ){ + // There are more than one vertex id's using the same key info + ArrayList vertList = new ArrayList (); + for (int i = 0; i < vidList.size(); i++) { + String tmpVid = vidList.get(i); + vertList.add(vtxHash.get(tmpVid)); + } + returnList.add(vertList); + } + } + catch (Exception e) { + LOGGER.warn(" >>> Threw an error in getDupeSets4NonDepNodes - just absorb this error and move on. ", e); + } + + } + return returnList; + + }// End of getDupeSets4NonDepNodes() + + + /** + * Get values of the key properties for a node as a single string + * + * @param tvx the vertex to pull the properties from + * @param keyPropNamesArr collection of key prop names + * @return a String of concatenated values + */ + private static String getNodeKeyValString( Vertex tvx, + ArrayList keyPropNamesArr ) { + + String retString = ""; + Iterator propItr = keyPropNamesArr.iterator(); + while( propItr.hasNext() ){ + String propName = propItr.next(); + if( tvx != null ){ + Object propValObj = tvx.property(propName).orElse(null); + retString = " " + retString + propValObj.toString(); + } + } + return retString; + + }// End of getNodeKeyValString() + + + static private String findJustOneUsingIndex( String transId, String fromAppId, + GraphTraversalSource gts, HashMap keyPropValsHash, + String nType, Long vidAL, Long vidBL, String apiVer){ + + // See if querying by JUST the key params (which should be indexed) brings back + // ONLY one of the two vertices. Ie. the db still has a pointer to one of them + // and the other one is sort of stranded. + String returnVid = ""; + + try { + List tmpVertList = getNodeJustUsingKeyParams( transId, fromAppId, gts, + nType, keyPropValsHash, apiVer ); + if( tmpVertList != null && tmpVertList.size() == 1 ){ + // We got just one - if it matches one of the ones we're looking + // for, then return that VID + Vertex tmpV = tmpVertList.get(0); + String thisVid = tmpV.id().toString(); + if( thisVid.equals(vidAL.toString()) || thisVid.equals(vidBL.toString()) ){ + String msg = " vid = " + thisVid + " is one of two that the DB can retrieve directly ------"; + //System.out.println(msg); + LOGGER.info(msg); + returnVid = thisVid; + } + } + } + catch ( AAIException ae ){ + String emsg = "Error trying to get node just by key " + ae.getMessage(); + //System.out.println(emsg); + LOGGER.error(emsg); + } + + return returnVid; + + }// End of findJustOneUsingIndex() + } diff --git a/aai-core/src/main/java/org/onap/aai/dbgen/DynamicPayloadGenerator.java b/aai-core/src/main/java/org/onap/aai/dbgen/DynamicPayloadGenerator.java new file mode 100644 index 00000000..52fc8f19 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dbgen/DynamicPayloadGenerator.java @@ -0,0 +1,498 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.dbgen; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileWriter; +import java.io.IOException; +import java.io.InputStream; +import java.io.UnsupportedEncodingException; +import java.net.URI; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Scanner; +import java.util.Set; +import java.util.UUID; + +import org.apache.commons.lang.exception.ExceptionUtils; +import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree; +import org.apache.tinkerpop.gremlin.structure.Element; +import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.onap.aai.db.props.AAIProperties; +import org.onap.aai.dbmap.DBConnectionType; +import org.onap.aai.dbmap.InMemoryGraph; +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.exceptions.AAIUnknownObjectException; +import org.onap.aai.logging.LogFormatTools; +import org.onap.aai.parsers.uri.URIToObject; +import org.onap.aai.serialization.engines.InMemoryDBEngine; +import org.onap.aai.serialization.engines.QueryStyle; +import org.onap.aai.serialization.db.DBSerializer; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; + +import org.slf4j.MDC; + +import org.codehaus.jackson.JsonNode; +import org.codehaus.jackson.map.ObjectMapper; +import org.codehaus.jackson.node.ObjectNode; +import org.codehaus.jackson.type.TypeReference; + +import java.util.Date; +import java.text.DateFormat; +import java.text.SimpleDateFormat; +import org.onap.aai.serialization.tinkerpop.TreeBackedVertex; +import org.onap.aai.util.AAIConfig; +import org.onap.aai.util.AAIConstants; + +import com.beust.jcommander.JCommander; +import com.beust.jcommander.Parameter; + +/** + * The Class ListEndpoints. + */ +public class DynamicPayloadGenerator { + + /* + * Create a Dynamic memory graph instance which should not affect the + * AAIGraph + */ + private InMemoryGraph inMemGraph = null; + private InMemoryDBEngine dbEngine; + + /* + * Loader, QueryStyle, ConnectionType for the Serializer + */ + private Loader loader; + private String urlBase; + private BufferedWriter bw = null; + + private CommandLineArgs cArgs; + + private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(DynamicPayloadGenerator.class); + + private static final QueryStyle queryStyle = QueryStyle.TRAVERSAL; + private static final DBConnectionType type = DBConnectionType.CACHED; + private static final ModelType introspectorFactoryType = ModelType.MOXY; + + /* + * Version + */ + private static final Version version = Version.getLatest(); + + /** + * The main method. + * + * @param args + * the arguments + * @throws AAIException + * @throws Exception + */ + public static void main(String[] args) { + + MDC.put("logFilenameAppender", DynamicPayloadGenerator.class.getSimpleName()); + DynamicPayloadGenerator payloadgen = new DynamicPayloadGenerator(); + try { + payloadgen.init(args); + + payloadgen.generatePayloads(); + } catch (AAIException e) { + LOGGER.error("Exception " + LogFormatTools.getStackTop(e)); + } catch (IOException e) { + LOGGER.error("Exception " + LogFormatTools.getStackTop(e)); + } + System.exit(0); + } + + public void init(String[] args) throws AAIException { + cArgs = new CommandLineArgs(); + JCommander jCommander = new JCommander(cArgs, args); + jCommander.setProgramName(DynamicPayloadGenerator.class.getSimpleName()); + LOGGER.info("Snapshot file" + cArgs.dataSnapshot); + //TODO- How to add dynamic.properties + + + LOGGER.info("output file" + cArgs.output); + + + LOGGER.info("format file" + cArgs.format); + LOGGER.info("format file" + cArgs.schemaEnabled); + if(cArgs.config.isEmpty()) + cArgs.config = AAIConstants.AAI_HOME_ETC_APP_PROPERTIES + "dynamic.properties"; + + LOGGER.info("config file" + cArgs.config); + if(cArgs.nodePropertyFile.isEmpty()) + cArgs.nodePropertyFile = AAIConstants.AAI_HOME_ETC_SCRIPT + "/tenant_isolation/nodes.json"; + LOGGER.info("nodePropertyFile file" + cArgs.nodePropertyFile); + AAIConfig.init(); + + urlBase = AAIConfig.get("aai.server.url.base", ""); + + } + + public void generatePayloads() throws AAIException, IOException{ + + List>> nodeFilters = readFile(cArgs.nodePropertyFile); + LOGGER.info("Load the Graph"); + + this.loadGraph(); + LOGGER.info("Generate payload"); + this.generatePayload(nodeFilters); + LOGGER.info("Close graph"); + this.closeGraph(); + + } + + private List>> readFile(String inputFile) throws IOException { + + InputStream is = new FileInputStream(inputFile); + Scanner scanner = new Scanner(is); + String jsonFile = scanner.useDelimiter("\\Z").next(); + scanner.close(); + + List>> allNodes = new ArrayList<>(); + Map> filterCousins = new HashMap<>(); + Map> filterParents = new HashMap<>(); + + ObjectMapper mapper = new ObjectMapper(); + + JsonNode rootNode = mapper.readTree(jsonFile); + + Iterator> nodeFields = rootNode.getFields(); + + while (nodeFields.hasNext()) { + Entry entry = nodeFields.next(); + String nodeType = entry.getKey(); + JsonNode nodeProperty = entry.getValue(); + + JsonNode cousinFilter = nodeProperty.path("cousins"); + JsonNode parentFilter = nodeProperty.path("parents"); + List cousins = new ObjectMapper().readValue(cousinFilter.traverse(), + new TypeReference>() { + }); + + List parents = new ObjectMapper().readValue(parentFilter.traverse(), + new TypeReference>() { + }); + for (String cousin : cousins) { + LOGGER.info("Cousins-Filtered" + cousin); + } + for (String parent : parents) { + LOGGER.info("Parents-Filtered" + parent); + } + filterCousins.put(nodeType, cousins); + filterParents.put(nodeType, parents); + + } + + allNodes.add(filterCousins); + allNodes.add(filterParents); + return allNodes; + + } + + private void loadGraph() throws IOException { + + loadGraphIntoMemory(); + buildDbEngine(); + + } + + private void loadGraphIntoMemory() throws IOException { + + inMemGraph = new InMemoryGraph.Builder().build(cArgs.dataSnapshot, cArgs.config, cArgs.schemaEnabled); + + } + + private void buildDbEngine() { + // TODO : parametrise version + loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); + + dbEngine = new InMemoryDBEngine(queryStyle, type, loader, inMemGraph.getGraph()); + dbEngine.startTransaction(); + } + + private void generatePayload(List>> nodeFilters) throws AAIException, IOException { + + Map> filterCousinsMap = nodeFilters.get(0); + Map> filterParentsMap = nodeFilters.get(1); + + Set nodeTypes = filterCousinsMap.keySet(); + + for (String nodeType : nodeTypes) { + if ("DMAAP-MR".equals(cArgs.format)) { + bw = createFile(nodeType + ".json"); + } + List filterCousins = filterCousinsMap.get(nodeType); + List filterParents = filterParentsMap.get(nodeType); + readVertices(nodeType, filterCousins, filterParents); + bw.close(); + LOGGER.info("All Done-" + nodeType); + } + + } + + private BufferedWriter createFile(String outfileName) throws IOException { + // FileLocation + String fileName = outfileName; + + File outFile = new File(fileName); + LOGGER.info(" Will write to " + outFile); + FileWriter fw = new FileWriter(outFile.getAbsoluteFile()); + return new BufferedWriter(fw); + + } + + private void createDirectory(String dirName) throws IOException { + // FileLocation + Path pathDir = Paths.get(dirName); + Files.createDirectories(pathDir); + + } + + public void readVertices(String nodeType, List filterCousins, List filterParents) + throws AAIException, IOException { + + DBSerializer serializer = new DBSerializer(version, dbEngine, introspectorFactoryType, "sourceOfTruth"); + List nodes = inMemGraph.getGraph().traversal().V().has("aai-node-type", nodeType).toList(); + + LOGGER.info("Number of nodes" + nodes.size()); + String dirName = cArgs.output + AAIConstants.AAI_FILESEP + nodeType + AAIConstants.AAI_FILESEP; + createDirectory( dirName); + // TODO: Formatter + if ("DMAAP-MR".equals(cArgs.format)) { + for (Vertex node : nodes) { + + Introspector nodeObj = serializer.getLatestVersionView(node); + createPayloadForDmaap(node, nodeObj); + + } + } + int counter = 0; + if ("PAYLOAD".equals(cArgs.format)) { + for (Vertex node : nodes) { + + counter++; + String filename = dirName + counter + "-" + nodeType + ".json"; + bw = createFile(filename); + Introspector obj = loader.introspectorFromName(nodeType); + Set seen = new HashSet<>(); + int depth = AAIProperties.MAXIMUM_DEPTH; + boolean nodeOnly = false; + + Tree tree = dbEngine.getQueryEngine().findSubGraph(node, depth, nodeOnly); + TreeBackedVertex treeVertex = new TreeBackedVertex(node, tree); + serializer.dbToObjectWithFilters(obj, treeVertex, seen, depth, nodeOnly, filterCousins, filterParents); + createPayloadForPut(obj); + bw.close(); + + URI uri = serializer.getURIForVertex(node); + String filenameWithUri = dirName + counter + "-" + nodeType + ".txt"; + bw = createFile(filenameWithUri); + bw.write(uri.toString()); + bw.newLine(); + bw.close(); + } + } + + } + + public void createPayloadForPut(Introspector nodeObj) throws IOException { + + String entityJson = nodeObj.marshal(false); + ObjectMapper mapper = new ObjectMapper(); + + ObjectNode rootNode = (ObjectNode) mapper.readTree(entityJson); + rootNode.remove("resource-version"); + + bw.newLine(); + bw.write(rootNode.toString()); + bw.newLine(); + } + + public void createPayloadForDmaap(Vertex node, Introspector nodeObj) + throws AAIException, UnsupportedEncodingException { + + DBSerializer serializer = new DBSerializer(version, dbEngine, introspectorFactoryType, "sourceOfTruth"); + + URI uri = serializer.getURIForVertex(node); + + String sourceOfTruth = ""; + HashMap relatedVertices = new HashMap<>(); + List vertexChain = dbEngine.getQueryEngine().findParents(node); + + for (Vertex vertex : vertexChain) { + try { + + Introspector vertexObj = serializer.getVertexProperties(vertex); + + relatedVertices.put(vertexObj.getObjectId(), vertexObj); + } catch (AAIUnknownObjectException e) { + LOGGER.warn("Unable to get vertex properties, partial list of related vertices returned"); + } + + } + + String transactionId = "TXID"; + createNotificationEvent(transactionId, sourceOfTruth, uri, nodeObj, relatedVertices); + + } + + public void createNotificationEvent(String transactionId, String sourceOfTruth, URI uri, Introspector obj, + Map relatedObjects) throws AAIException, UnsupportedEncodingException { + + String action = "CREATE"; + final Introspector notificationEvent = loader.introspectorFromName("notification-event"); + + try { + Introspector eventHeader = loader.introspectorFromName("notification-event-header"); + URIToObject parser = new URIToObject(loader, uri, (HashMap) relatedObjects); + + String entityLink = urlBase + version + uri; + + notificationEvent.setValue("cambria-partition", "AAI"); + + eventHeader.setValue("entity-link", entityLink); + eventHeader.setValue("action", action); + eventHeader.setValue("entity-type", obj.getDbName()); + eventHeader.setValue("top-entity-type", parser.getTopEntityName()); + eventHeader.setValue("source-name", sourceOfTruth); + eventHeader.setValue("version", version.toString()); + eventHeader.setValue("id", transactionId); + eventHeader.setValue("event-type", "AAI-BASELINE"); + if (eventHeader.getValue("domain") == null) { + eventHeader.setValue("domain", AAIConfig.get("aai.notificationEvent.default.domain", "UNK")); + } + + if (eventHeader.getValue("sequence-number") == null) { + eventHeader.setValue("sequence-number", + AAIConfig.get("aai.notificationEvent.default.sequenceNumber", "UNK")); + } + + if (eventHeader.getValue("severity") == null) { + eventHeader.setValue("severity", AAIConfig.get("aai.notificationEvent.default.severity", "UNK")); + } + + if (eventHeader.getValue("id") == null) { + eventHeader.setValue("id", genDate2() + "-" + UUID.randomUUID().toString()); + + } + + if (eventHeader.getValue("timestamp") == null) { + eventHeader.setValue("timestamp", genDate()); + } + + List parentList = parser.getParentList(); + parentList.clear(); + + if (!parser.getTopEntity().equals(parser.getEntity())) { + Introspector child; + String json = obj.marshal(false); + child = parser.getLoader().unmarshal(parser.getEntity().getName(), json); + parentList.add(child.getUnderlyingObject()); + } + + final Introspector eventObject; + + String json = ""; + if (parser.getTopEntity().equals(parser.getEntity())) { + json = obj.marshal(false); + eventObject = loader.unmarshal(obj.getName(), json); + } else { + json = parser.getTopEntity().marshal(false); + + eventObject = loader.unmarshal(parser.getTopEntity().getName(), json); + } + notificationEvent.setValue("event-header", eventHeader.getUnderlyingObject()); + notificationEvent.setValue("entity", eventObject.getUnderlyingObject()); + + String entityJson = notificationEvent.marshal(false); + + bw.newLine(); + bw.write(entityJson); + + } catch (AAIUnknownObjectException e) { + LOGGER.error("Fatal error - notification-event-header object not found!"); + } catch (Exception e) { + LOGGER.error("Unmarshalling error occurred while generating Notification " + LogFormatTools.getStackTop(e)); + } + } + + private void closeGraph() { + inMemGraph.getGraph().tx().rollback(); + inMemGraph.getGraph().close(); + } + + public static String genDate() { + Date date = new Date(); + DateFormat formatter = new SimpleDateFormat("yyyyMMdd-HH:mm:ss:SSS"); + return formatter.format(date); + } + + public static String genDate2() { + Date date = new Date(); + DateFormat formatter = new SimpleDateFormat("yyyyMMddHHmmss"); + return formatter.format(date); + } + +} + +class CommandLineArgs { + + @Parameter(names = "--help", help = true) + public boolean help; + + @Parameter(names = "-d", description = "snapshot file to be loaded") + public String dataSnapshot; + + @Parameter(names = "-s", description = "is schema to be enabled ", arity = 1) + public boolean schemaEnabled = true; + + @Parameter(names = "-c", description = "location of configuration file") + public String config = ""; + + @Parameter(names = "-o", description = "output location") + public String output = ""; + + @Parameter(names = "-f", description = "format of output") + public String format = "PAYLOAD"; + + @Parameter(names = "-n", description = "Node input file") + public String nodePropertyFile = ""; + +} diff --git a/aai-core/src/main/java/org/onap/aai/dbgen/GenTester.java b/aai-core/src/main/java/org/onap/aai/dbgen/GenTester.java index 7b9eb2fc..81672949 100644 --- a/aai-core/src/main/java/org/onap/aai/dbgen/GenTester.java +++ b/aai-core/src/main/java/org/onap/aai/dbgen/GenTester.java @@ -28,10 +28,13 @@ import com.thinkaurelius.titan.core.TitanGraph; import com.thinkaurelius.titan.core.schema.TitanManagement; import org.onap.aai.dbmap.AAIGraph; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; import org.onap.aai.util.AAIConfig; import org.onap.aai.util.AAIConstants; import java.util.Properties; +import java.util.UUID; public class GenTester { @@ -46,7 +49,7 @@ public class GenTester { public static void main(String[] args) { TitanGraph graph = null; - + System.setProperty("aai.service.name", GenTester.class.getSimpleName()); // Set the logging file properties to be used by EELFManager Properties props = System.getProperties(); props.setProperty(Configuration.PROPERTY_LOGGING_FILE_NAME, AAIConstants.AAI_CREATE_DB_SCHEMA_LOGBACK_PROPS); @@ -54,7 +57,16 @@ public class GenTester { LOGGER = EELFManager.getInstance().getLogger(GenTester.class); boolean addDefaultCR = true; - try { + LoggingContext.init(); + LoggingContext.component("DBGenTester"); + LoggingContext.partnerName("AAI-TOOLS"); + LoggingContext.targetEntity("AAI"); + LoggingContext.requestId(UUID.randomUUID().toString()); + LoggingContext.serviceName("AAI"); + LoggingContext.targetServiceName("main"); + LoggingContext.statusCode(StatusCode.COMPLETE); + LoggingContext.responseCode(LoggingContext.SUCCESS); + try { AAIConfig.init(); if (args != null && args.length > 0 ){ if( "genDbRulesOnly".equals(args[0]) ){ @@ -88,6 +100,8 @@ public class GenTester { String emsg = "Unrecognized argument passed to GenTester.java: [" + args[0] + "]. "; System.out.println(emsg); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); LOGGER.error(emsg); emsg = "Either pass no argument for normal processing, or use 'GEN_DB_WITH_NO_SCHEMA'."; diff --git a/aai-core/src/main/java/org/onap/aai/dbgen/SchemaGenerator.java b/aai-core/src/main/java/org/onap/aai/dbgen/SchemaGenerator.java index 132ad46a..e26ba2c2 100644 --- a/aai-core/src/main/java/org/onap/aai/dbgen/SchemaGenerator.java +++ b/aai-core/src/main/java/org/onap/aai/dbgen/SchemaGenerator.java @@ -34,6 +34,7 @@ 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.logging.LogFormatTools; import org.onap.aai.schema.enums.PropertyMetadata; import org.onap.aai.serialization.db.EdgeRule; import org.onap.aai.serialization.db.EdgeRules; @@ -80,7 +81,7 @@ public class SchemaGenerator{ AAIConfig.init(); } catch (Exception ex){ - LOGGER.error(" ERROR - Could not run AAIConfig.init(). ", ex); + LOGGER.error(" ERROR - Could not run AAIConfig.init(). " + LogFormatTools.getStackTop(ex)); System.out.println(" ERROR - Could not run AAIConfig.init(). "); System.exit(1); } diff --git a/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraph.java b/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraph.java index e62e8e7e..5c7abfe2 100644 --- a/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraph.java +++ b/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraph.java @@ -29,6 +29,7 @@ import java.util.HashMap; import java.util.Map; import java.util.Properties; +import org.apache.commons.configuration.PropertiesConfiguration; import org.apache.commons.lang.exception.ExceptionUtils; import org.apache.tinkerpop.gremlin.structure.Graph; import org.apache.tinkerpop.gremlin.structure.io.IoCore; @@ -58,8 +59,9 @@ public class AAIGraph { private static final EELFLogger logger = EELFManager.getInstance().getLogger(AAIGraph.class); protected static final String COMPONENT = "aaidbmap"; protected Map graphs = new HashMap<>(); - private final String REALTIME_DB = "realtime"; - private final String CACHED_DB = "cached"; + private static final String REALTIME_DB = "realtime"; + private static final String CACHED_DB = "cached"; + private static boolean isInit = false; @@ -68,6 +70,7 @@ public class AAIGraph { */ private AAIGraph() { try { + String serviceName = System.getProperty("aai.service.name", "NA"); String rtConfig = System.getProperty("realtime.db.config"); String cachedConfig = System.getProperty("cached.db.config"); if (rtConfig == null) { @@ -76,8 +79,8 @@ public class AAIGraph { if (cachedConfig == null) { cachedConfig = AAIConstants.CACHED_DB_CONFIG; } - this.loadGraph(REALTIME_DB, rtConfig); - this.loadGraph(CACHED_DB, cachedConfig); + this.loadGraph(REALTIME_DB, rtConfig, serviceName); + this.loadGraph(CACHED_DB, cachedConfig, serviceName); } catch (Exception e) { throw new RuntimeException("Failed to instantiate graphs", e); } @@ -93,17 +96,23 @@ public class AAIGraph { * @return single instance of AAIGraph */ public static AAIGraph getInstance() { + isInit = true; return Helper.INSTANCE; } + + public static boolean isInit() { + return isInit; + } - private void loadGraph(String name, String configPath) throws AAIException { + private void loadGraph(String name, String configPath, String serviceName) throws Exception { // Graph being opened by TitanFactory is being placed in hashmap to be used later // These graphs shouldn't be closed until the application shutdown - TitanGraph graph = TitanFactory.open(configPath); - try (InputStream is = new FileInputStream(configPath)) { + try { + PropertiesConfiguration propertiesConfiguration = new AAIGraphConfig.Builder(configPath).forService(serviceName).withGraphType(name).buildConfiguration(); + TitanGraph graph = TitanFactory.open(propertiesConfiguration); Properties graphProps = new Properties(); - graphProps.load(is); + propertiesConfiguration.getKeys().forEachRemaining(k -> graphProps.setProperty(k, propertiesConfiguration.getString(k))); if ("inmemory".equals(graphProps.get("storage.backend"))) { // Load the propertyKeys, indexes and edge-Labels into the DB @@ -155,10 +164,10 @@ public class AAIGraph { } /** - * Graph shutdown. + * Close all of the graph connections made in the instance. */ public void graphShutdown() { - graphs.get(REALTIME_DB).close(); + graphs.values().stream().filter(TitanGraph::isOpen).forEach(TitanGraph::close); } /** diff --git a/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraphConfig.java b/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraphConfig.java new file mode 100644 index 00000000..e67051f0 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dbmap/AAIGraphConfig.java @@ -0,0 +1,107 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ + +package org.onap.aai.dbmap; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import com.google.common.base.Preconditions; +import com.google.common.base.Predicate; +import com.google.common.collect.Iterators; +import com.thinkaurelius.titan.diskstorage.configuration.ConfigElement; +import com.thinkaurelius.titan.diskstorage.configuration.backend.CommonsConfiguration; +import org.apache.commons.configuration.ConfigurationException; +import org.apache.commons.configuration.PropertiesConfiguration; +import org.apache.commons.lang.StringUtils; + +import java.io.File; +import java.io.FileNotFoundException; +import java.lang.management.ManagementFactory; +import java.util.Iterator; +import java.util.Objects; +import java.util.regex.Pattern; + +import static com.thinkaurelius.titan.graphdb.configuration.GraphDatabaseConfiguration.*; + +/** + * For building a config that TitanFactory.open can use with an identifiable graph.unique-instance-id + */ +public class AAIGraphConfig { + + private static final EELFLogger logger = EELFManager.getInstance().getLogger(AAIGraphConfig.class); + + private AAIGraphConfig(){}; + + public PropertiesConfiguration getCc(String configPath, String graphType, String service) throws ConfigurationException, FileNotFoundException { + + PropertiesConfiguration cc = this.loadTitanPropFile(configPath); + + String uid = ManagementFactory.getRuntimeMXBean().getName() + "_" + service + "_" + graphType + "_" + System.currentTimeMillis(); + for (char c : ConfigElement.ILLEGAL_CHARS) { + uid = StringUtils.replaceChars(uid, c,'_'); + } + + cc.addProperty("graph.unique-instance-id", uid); + + return cc; + } + + + private PropertiesConfiguration loadTitanPropFile(String shortcutOrFile) throws ConfigurationException, FileNotFoundException { + File file = new File(shortcutOrFile); + if (file.exists()) { + PropertiesConfiguration propertiesConfiguration = new PropertiesConfiguration(); + propertiesConfiguration.setAutoSave(false); + propertiesConfiguration.load(shortcutOrFile); + return propertiesConfiguration; + } else { + throw new FileNotFoundException(shortcutOrFile); + } + } + + public static class Builder { + private String configPath; + private String graphType; + private String service; + + public Builder(String configPath) { + this.configPath = configPath; + } + + public Builder withGraphType(String graphType) { + this.graphType = Objects.toString(graphType, "NA"); + return this; + } + + public Builder forService(String service) { + this.service = Objects.toString(service, "NA"); + return this; + } + + public PropertiesConfiguration buildConfiguration() throws ConfigurationException, FileNotFoundException { + return new AAIGraphConfig().getCc(this.configPath, this.graphType, this.service); + } + + } + + +} diff --git a/aai-core/src/main/java/org/onap/aai/dbmap/InMemoryGraph.java b/aai-core/src/main/java/org/onap/aai/dbmap/InMemoryGraph.java new file mode 100644 index 00000000..61b4e36e --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dbmap/InMemoryGraph.java @@ -0,0 +1,106 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.dbmap; + +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; + +import java.util.Properties; + +import org.apache.commons.lang.exception.ExceptionUtils; +import org.apache.tinkerpop.gremlin.structure.io.IoCore; +import org.onap.aai.dbgen.SchemaGenerator; +import org.onap.aai.logging.LogFormatTools; + +import com.thinkaurelius.titan.core.TitanFactory; +import com.thinkaurelius.titan.core.TitanGraph; +import com.thinkaurelius.titan.core.TitanTransaction; +import com.thinkaurelius.titan.core.schema.TitanManagement; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; + +public class InMemoryGraph { + + private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(InMemoryGraph.class); + private TitanGraph graph = null; + + + public InMemoryGraph(Builder builder) throws IOException { + /* + * Create a In-memory graph + */ + InputStream is = new FileInputStream(builder.propertyFile); + try { + graph = TitanFactory.open(builder.propertyFile); + + Properties graphProps = new Properties(); + graphProps.load(is); + TitanManagement graphMgt = graph.openManagement(); + if(builder.isSchemaEnabled){ + LOGGER.info("Schema Enabled"); + SchemaGenerator.loadSchemaIntoTitan(graph, graphMgt); + } + TitanTransaction transaction = graph.newTransaction(); + LOGGER.info("Loading snapshot"); + transaction.io(IoCore.graphson()).readGraph(builder.graphsonLocation); + transaction.commit(); + + } catch (Exception e) { + // TODO : Changesysout to logger + LOGGER.error( + "ERROR: Could not load datasnapshot to in memory graph. \n" + LogFormatTools.getStackTop(e)); + throw new IllegalStateException("Could not load datasnapshot to in memory graph"); + + } + finally{ + is.close(); + } + + } + + public static class Builder { + private String graphsonLocation = ""; + private String propertyFile = ""; + private boolean isSchemaEnabled = false; + + /* + * Builder constructor doesnt do anything + */ + public Builder() { + //Do nothing + } + + public InMemoryGraph build(String graphsonFile, String propertyFile, boolean isSchemaEnabled) throws IOException { + this.graphsonLocation = graphsonFile; + this.propertyFile = propertyFile; + this.isSchemaEnabled = isSchemaEnabled; + return new InMemoryGraph(this); + } + } + + public TitanGraph getGraph() { + return graph; + } + +} diff --git a/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSConsumer.java b/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSConsumer.java index d5389981..e52cc3ed 100644 --- a/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSConsumer.java +++ b/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSConsumer.java @@ -104,7 +104,16 @@ public class AAIDmaapEventJMSConsumer implements MessageListener { eventName = jo.getString("event-topic"); } + MDC.put ("targetEntity", "DMAAP"); + if (jo.getString("event-topic") != null) { + eventName = jo.getString("event-topic"); + MDC.put ("targetServiceName", eventName); + } + MDC.put ("serviceName", "AAI"); + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.COMPLETE.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "0"); LOGGER.info(eventName + "|" + aaiEvent); + if ("AAI-EVENT".equals(eventName)) { this.sentWithHttp(this.httpClient, this.aaiEventUrl, aaiEvent); } else { @@ -113,13 +122,21 @@ public class AAIDmaapEventJMSConsumer implements MessageListener { } } catch (java.net.SocketException e) { if (!e.getMessage().contains("Connection reset")) { + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.ERROR.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "200"); LOGGER.error("AAI_7304 Error reaching DMaaP to send event. " + aaiEvent, e); } } catch (IOException e) { + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.ERROR.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "200"); LOGGER.error("AAI_7304 Error reaching DMaaP to send event. " + aaiEvent, e); } catch (JMSException | JSONException e) { + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.ERROR.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "200"); LOGGER.error("AAI_7350 Error parsing aaievent jsm message for sending to dmaap. " + jsmMessageTxt, e); } catch (Exception e) { + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.ERROR.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "200"); LOGGER.error("AAI_7350 Error sending message to dmaap. " + jsmMessageTxt, e); } } diff --git a/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSProducer.java b/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSProducer.java index d41f4768..914042d4 100644 --- a/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSProducer.java +++ b/aai-core/src/main/java/org/onap/aai/dmaap/AAIDmaapEventJMSProducer.java @@ -35,7 +35,8 @@ public class AAIDmaapEventJMSProducer { public AAIDmaapEventJMSProducer() { if(AAIConfig.get("aai.jms.enable", "true").equals("true")){ this.jmsTemplate = new JmsTemplate(); - this.jmsTemplate.setConnectionFactory(new CachingConnectionFactory(new ActiveMQConnectionFactory("tcp://localhost:61447"))); + String activeMqTcpUrl = System.getProperty("activemq.tcp.url", "tcp://localhost:61447"); + this.jmsTemplate.setConnectionFactory(new CachingConnectionFactory(new ActiveMQConnectionFactory(activeMqTcpUrl))); this.jmsTemplate.setDefaultDestination(new ActiveMQQueue("IN_QUEUE")); } } diff --git a/aai-core/src/main/java/org/onap/aai/extensions/OrphanLInterfaceHandler.java b/aai-core/src/main/java/org/onap/aai/extensions/OrphanLInterfaceHandler.java new file mode 100644 index 00000000..3da4e227 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/extensions/OrphanLInterfaceHandler.java @@ -0,0 +1,112 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.extensions; + +import java.io.UnsupportedEncodingException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.List; + +import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.introspection.Introspector; +import org.onap.aai.introspection.Loader; +import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.parsers.query.QueryParser; +import org.onap.aai.query.builder.QueryBuilder; +import org.onap.aai.rest.db.DBRequest; +import org.onap.aai.restcore.HttpMethod; +import org.onap.aai.serialization.db.EdgeType; + +public class OrphanLInterfaceHandler { + + private QueryBuilder createLInterfaceQuery(AAIExtensionMap aaiReqMap, Introspector newvceObj) throws AAIException { + Introspector uplinkLInterfaceTraversalIntro = aaiReqMap.getLoader().introspectorFromName("l-interface"); + + Introspector customerUplinkLInterfaceTraversalIntro = aaiReqMap.getLoader().introspectorFromName("l-interface"); + + Introspector logLinkIntroForTraversal = aaiReqMap.getLoader().introspectorFromName("logical-link"); + + QueryBuilder query = aaiReqMap.getTransactionalGraphEngine().getQueryBuilder() + .exactMatchQuery(newvceObj) + .createEdgeTraversal(EdgeType.TREE, newvceObj, uplinkLInterfaceTraversalIntro) + .getVerticesByProperty("interface-role", "UPLINK") + .createEdgeTraversal(EdgeType.COUSIN, uplinkLInterfaceTraversalIntro, logLinkIntroForTraversal) + .createEdgeTraversal(EdgeType.COUSIN, logLinkIntroForTraversal, customerUplinkLInterfaceTraversalIntro) + .getVerticesByProperty("interface-role", "CUSTOMER-UPLINK").dedup(); + return query; + } + + private URI buildLInterfaceURI(Vertex linterface, AAIExtensionMap aaiReqMap) throws UnsupportedEncodingException, AAIException, URISyntaxException { + Loader loader = aaiReqMap.getLoader(); + Introspector lint = loader.introspectorFromName("l-interface"); + lint.setValue("interface-name", (String)linterface.property("interface-name").value()); + String lintSegment = lint.getURI(); + + Introspector lagInterfaceForTrav = loader.introspectorFromName("lag-interface"); + QueryBuilder lagIntQuery = aaiReqMap.getTransactionalGraphEngine().getQueryBuilder() + .exactMatchQuery(lint) + .createEdgeTraversal(EdgeType.TREE, linterface, lagInterfaceForTrav).dedup(); + List lagInterfaces = lagIntQuery.toList(); + if (lagInterfaces.isEmpty()) { + throw new AAIException("AAI_6114"); + } else if (lagInterfaces.size() > 1) { + throw new AAIException("AAI_6140"); + } + Vertex lagInt = lagInterfaces.get(0); + lagInterfaceForTrav.setValue("interface-name", (String)lagInt.property("interface-name").value()); + String lagSegment = lagInterfaceForTrav.getURI(); + + Introspector gvVPEforTrav = loader.introspectorFromName("generic-vnf"); + QueryBuilder gvVPEquery = aaiReqMap.getTransactionalGraphEngine().getQueryBuilder() + .exactMatchQuery(lagInterfaceForTrav) + .createEdgeTraversal(EdgeType.TREE, lagInterfaceForTrav, gvVPEforTrav).dedup(); + List genvnfs = gvVPEquery.toList(); + if (genvnfs.isEmpty()) { + throw new AAIException("AAI_6114"); + } else if (genvnfs.size() > 1) { + throw new AAIException("AAI_6140"); + } + Vertex genvnf = genvnfs.get(0); + gvVPEforTrav.setValue("vnf-id", (String)genvnf.property("vnf-id").value()); + String gvSegment = gvVPEforTrav.getURI(); + + return new URI(gvSegment + lagSegment + lintSegment); + } + + public List createOrphanLInterfaceDelRequests(AAIExtensionMap aaiReqMap, Introspector newvce) throws AAIException, UnsupportedEncodingException, URISyntaxException{ + List requests = new ArrayList<>(); + QueryBuilder query = createLInterfaceQuery(aaiReqMap, newvce); + List linterfaces = query.toList(); + + for (Vertex lint : linterfaces) { + URI lintURI = buildLInterfaceURI(lint, aaiReqMap); + QueryParser parser = createLInterfaceQuery(aaiReqMap, newvce).createQueryFromObjectName("l-interface"); + DBRequest originalDbRequest = aaiReqMap.getDbRequest(); + DBRequest request = new DBRequest.Builder(HttpMethod.DELETE, lintURI, parser, newvce, originalDbRequest.getHeaders(), originalDbRequest.getInfo(), originalDbRequest.getTransactionId()).build(); + requests.add(request); + } + + return requests; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/introspection/Introspector.java b/aai-core/src/main/java/org/onap/aai/introspection/Introspector.java index f6609bff..fa8be863 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/Introspector.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/Introspector.java @@ -28,6 +28,7 @@ import org.apache.commons.lang.ClassUtils; import org.eclipse.persistence.exceptions.DynamicException; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.restcore.MediaType; import org.onap.aai.schema.enums.ObjectMetadata; import org.onap.aai.schema.enums.PropertyMetadata; @@ -465,7 +466,7 @@ public abstract class Introspector implements Cloneable { break; } } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping inheritor " + inheritor + " (Unknown Object)", e); + LOGGER.warn("Skipping inheritor " + inheritor + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } } else { diff --git a/aai-core/src/main/java/org/onap/aai/introspection/IntrospectorWalker.java b/aai-core/src/main/java/org/onap/aai/introspection/IntrospectorWalker.java index 09dcec64..e939b6d9 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/IntrospectorWalker.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/IntrospectorWalker.java @@ -25,6 +25,7 @@ import com.att.eelf.configuration.EELFLogger; import com.att.eelf.configuration.EELFManager; import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.logging.LogFormatTools; import java.util.HashSet; import java.util.LinkedHashSet; @@ -141,7 +142,7 @@ public class IntrospectorWalker { walk(child, parent, localVisited); } } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping property " + prop + " (Unknown Object)", e); + LOGGER.warn("Skipping property " + prop + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } else { w.processPrimitiveList(prop, obj); @@ -159,7 +160,7 @@ public class IntrospectorWalker { obj.setValue(prop, listReference); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping property " + prop + " (Unknown Object)", e); + LOGGER.warn("Skipping property " + prop + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } else if (!isComplexType){ w.processPrimitiveList(prop, obj); @@ -176,7 +177,7 @@ public class IntrospectorWalker { child = obj.newIntrospectorInstanceOfProperty(prop); obj.setValue(prop, child.getUnderlyingObject()); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping property " + prop + " (Unknown Object)", e); + LOGGER.warn("Skipping property " + prop + " (Unknown Object) " + LogFormatTools.getStackTop(e)); } } } diff --git a/aai-core/src/main/java/org/onap/aai/introspection/ModelInjestor.java b/aai-core/src/main/java/org/onap/aai/introspection/ModelInjestor.java index 4cdfc634..c670e946 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/ModelInjestor.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/ModelInjestor.java @@ -105,7 +105,7 @@ public class ModelInjestor { */ public Version getVersionFromClassName (String classname) { Matcher m = classNamePattern.matcher(classname); - String version = "v2"; //for the OXM, only the v2 ones don't include a model name, hence this default + String version = "v12"; if (m.find()) { version = m.group(1); } diff --git a/aai-core/src/main/java/org/onap/aai/introspection/MoxyLoader.java b/aai-core/src/main/java/org/onap/aai/introspection/MoxyLoader.java index cf81349c..56ad2dc2 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/MoxyLoader.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/MoxyLoader.java @@ -32,6 +32,7 @@ import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.introspection.exceptions.AAIUnmarshallingException; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.restcore.MediaType; import org.onap.aai.workarounds.NamingExceptions; import org.w3c.dom.Document; @@ -157,7 +158,7 @@ public class MoxyLoader extends Loader { Introspector introspector = this.introspectorFromName(objName); map.put(introspector.getDbName(), introspector); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Unexpected AAIUnknownObjectException while running getAllObjects()", e); + LOGGER.warn("Unexpected AAIUnknownObjectException while running getAllObjects() " + LogFormatTools.getStackTop(e)); } } allObjs = map.build(); @@ -182,7 +183,7 @@ public class MoxyLoader extends Loader { result.add(list.item(i).getAttributes().getNamedItem("name").getNodeValue()); } } catch (ParserConfigurationException | SAXException | IOException e) { - LOGGER.warn("Exception while enumerating objects for API version " + getVersion() + " (returning partial results)", e); + LOGGER.warn("Exception while enumerating objects for API version " + getVersion() + " (returning partial results) " + LogFormatTools.getStackTop(e)); } //result.remove("EdgePropNames"); diff --git a/aai-core/src/main/java/org/onap/aai/introspection/PojoLoader.java b/aai-core/src/main/java/org/onap/aai/introspection/PojoLoader.java index 62a7dc0e..88411476 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/PojoLoader.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/PojoLoader.java @@ -30,6 +30,7 @@ import org.onap.aai.db.props.AAIProperties; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.introspection.exceptions.AAIUnmarshallingException; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.restcore.MediaType; import org.onap.aai.workarounds.NamingExceptions; @@ -60,7 +61,7 @@ public class PojoLoader extends Loader { try { context = JAXBContextFactory.createContext(pojoPackageName, this.getClass().getClassLoader()); } catch (JAXBException e) { - LOGGER.error("JAXBException while instantiation contect for PojoLoader", e); + LOGGER.error("JAXBException while instantiation contect for PojoLoader " + LogFormatTools.getStackTop(e)); } } diff --git a/aai-core/src/main/java/org/onap/aai/introspection/tools/CreateUUID.java b/aai-core/src/main/java/org/onap/aai/introspection/tools/CreateUUID.java index b049c5c5..a061ad6f 100644 --- a/aai-core/src/main/java/org/onap/aai/introspection/tools/CreateUUID.java +++ b/aai-core/src/main/java/org/onap/aai/introspection/tools/CreateUUID.java @@ -27,10 +27,37 @@ import org.onap.aai.schema.enums.PropertyMetadata; import java.util.Map; import java.util.UUID; +/** + * CreateUUID is an issue resolver that is responsible + * for looking to check if the property that is missing has + * the metadata autoGenerateUuid associated to it in the oxm + * As if that is found, then it will automatically resolve the + * issue by generating a uuid and setting that value to that property + * + * If this is needed for a specific property that you need + * then you need to add the following xml code in the oxm + * + * 
+ *     {@code
+ *      
+ *      
+ *          
+ *      
+ *     }
+ *
+ */ public class CreateUUID implements IssueResolver { /** - * {@inheritDoc} + * Resolves the issue by checking if the issue type is missing key prop + * and if it is it will retrieve the introspector associated with the issue + * then gets the metadata associated to that specific property + * and if it contains the auto generate meta property and if it does + * then it will fix it by setting that property value to generated uuid + * + * @param issue the issue with the details associated to the problem + * @return true if the issue has been successfully resolved + * false otherwise */ @Override public boolean resolveIssue(Issue issue) { diff --git a/aai-core/src/main/java/org/onap/aai/logging/EcompErrorCategory.java b/aai-core/src/main/java/org/onap/aai/logging/EcompErrorCategory.java new file mode 100644 index 00000000..9bf4056e --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/logging/EcompErrorCategory.java @@ -0,0 +1,44 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import ch.qos.logback.classic.pattern.ClassicConverter; +import ch.qos.logback.classic.spi.ILoggingEvent; +import ch.qos.logback.classic.Level; + +public class EcompErrorCategory extends ClassicConverter { + + @Override + public String convert(ILoggingEvent event) { + + final Level lev = event.getLevel(); + final String defaultCategory = "WARN"; + + if ((Level.WARN).equals(lev)) { + return (defaultCategory); + } + else if ((Level.ERROR).equals(lev)) { + return ("ERROR"); + } + return (defaultCategory); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/logging/EcompPatternLayout.java b/aai-core/src/main/java/org/onap/aai/logging/EcompPatternLayout.java index a08c021f..b0eba743 100644 --- a/aai-core/src/main/java/org/onap/aai/logging/EcompPatternLayout.java +++ b/aai-core/src/main/java/org/onap/aai/logging/EcompPatternLayout.java @@ -28,5 +28,8 @@ public class EcompPatternLayout extends PatternLayout { PatternLayout.defaultConverterMap.put("ecompStartTime", EcompStartTime.class.getName()); PatternLayout.defaultConverterMap.put("ecompElapsedTime", EcompElapsedTime.class.getName()); PatternLayout.defaultConverterMap.put("eelfClassOfCaller", EelfClassOfCaller.class.getName()); + PatternLayout.defaultConverterMap.put("ecompErrorCategory", EcompErrorCategory.class.getName()); + PatternLayout.defaultConverterMap.put("ecompResponseCode", EcompResponseCode.class.getName()); + PatternLayout.defaultConverterMap.put("ecompResponseDescription", EcompResponseDescription.class.getName()); } } diff --git a/aai-core/src/main/java/org/onap/aai/logging/EcompResponseCode.java b/aai-core/src/main/java/org/onap/aai/logging/EcompResponseCode.java new file mode 100644 index 00000000..af3fdb71 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/logging/EcompResponseCode.java @@ -0,0 +1,40 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import org.onap.aai.logging.LoggingContext.LoggingField; + +import ch.qos.logback.classic.pattern.ClassicConverter; +import ch.qos.logback.classic.spi.ILoggingEvent; + +public class EcompResponseCode extends ClassicConverter { + + @Override + public String convert(ILoggingEvent event) { + + if (!event.getMDCPropertyMap().containsKey(LoggingField.RESPONSE_CODE.toString())) { + // if response code is not set, return "unknown" (900) + return LoggingContext.UNKNOWN_ERROR; + } + return event.getMDCPropertyMap().get(LoggingField.RESPONSE_CODE.toString()); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/logging/EcompResponseDescription.java b/aai-core/src/main/java/org/onap/aai/logging/EcompResponseDescription.java new file mode 100644 index 00000000..6ef4b758 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/logging/EcompResponseDescription.java @@ -0,0 +1,46 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import org.onap.aai.logging.LoggingContext.LoggingField; + +import ch.qos.logback.classic.pattern.ClassicConverter; +import ch.qos.logback.classic.spi.ILoggingEvent; + +public class EcompResponseDescription extends ClassicConverter { + public final static String DefaultDescription = "Unknown response/error description"; + @Override + public String convert(ILoggingEvent event) { + + if (!event.getMDCPropertyMap().containsKey(LoggingField.RESPONSE_DESCRIPTION.toString())) { + return (DefaultDescription); + } + // Replace pipes and new lines + String currentDesc = event.getMDCPropertyMap().get(LoggingField.RESPONSE_DESCRIPTION.toString()); + if ( (currentDesc == null) || (currentDesc.length() == 0) ) { + return (DefaultDescription); + } + currentDesc = currentDesc.replaceAll("|", "!"); + currentDesc = currentDesc.replaceAll("[\\r\\n]+", "^"); + return event.getMDCPropertyMap().get(LoggingField.RESPONSE_DESCRIPTION.toString()); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/logging/ErrorLogHelper.java b/aai-core/src/main/java/org/onap/aai/logging/ErrorLogHelper.java index 1c3ab853..a585a4a9 100644 --- a/aai-core/src/main/java/org/onap/aai/logging/ErrorLogHelper.java +++ b/aai-core/src/main/java/org/onap/aai/logging/ErrorLogHelper.java @@ -291,7 +291,7 @@ public class ErrorLogHelper { } } catch (Exception ex) { - LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error", ex); + LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error " + ex.getMessage()); } } else { @@ -319,7 +319,7 @@ public class ErrorLogHelper { response = (MapperUtil.writeAsJSONString((Object) restresp)); } } catch (AAIException ex) { - LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error", ex); + LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error " + ex.getMessage()); } } } @@ -343,7 +343,7 @@ public class ErrorLogHelper { public static String getRESTAPIErrorResponseWithLogging(List acceptHeadersOrig, AAIException are, ArrayList variables) { String response = ErrorLogHelper.getRESTAPIErrorResponse(acceptHeadersOrig, are, variables); - LOGGER.error(are.getMessage(), are); + LOGGER.error(are.getMessage() + " " + LogFormatTools.getStackTop(are)); return response; } @@ -427,7 +427,7 @@ public class ErrorLogHelper { responseMessages.getResponseMessage().add(responseMessage); } catch (Exception ex) { - LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error", ex); + LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error " + ex.getMessage()); } } @@ -553,7 +553,7 @@ public class ErrorLogHelper { } } catch (Exception ex) { - LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error", ex); + LOGGER.error("We were unable to create a rest exception to return on an API because of a parsing error "+ ex.getMessage()); } return response; } @@ -571,7 +571,13 @@ public class ErrorLogHelper { LoggingContext.severity(sevCode); } } - + String stackTrace = ""; + try { + stackTrace = LogFormatTools.getStackTop(e); + } + catch (Exception a) { + //ignore + } final String errorMessage = new StringBuilder() .append(errorObject.getErrorText()) .append(":") @@ -586,14 +592,19 @@ public class ErrorLogHelper { LoggingContext.responseDescription(errorMessage); LoggingContext.statusCode(StatusCode.ERROR); + final String details = new StringBuilder().append(errorObject.getErrorCodeString()) + .append(" ") + .append(stackTrace) + .toString(); + if (errorObject.getSeverity().equalsIgnoreCase("WARN")) - LOGGER.warn(errorMessage, e); + LOGGER.warn(details); else if (errorObject.getSeverity().equalsIgnoreCase("ERROR")) - LOGGER.error(errorMessage, e); + LOGGER.error(details); else if (errorObject.getSeverity().equalsIgnoreCase("FATAL")) - LOGGER.error(errorMessage, e); + LOGGER.error(details); else if (errorObject.getSeverity().equals("INFO")) - LOGGER.info(errorMessage + ", " + e.getMessage()); + LOGGER.info(details); } public static void logError(String code) { diff --git a/aai-core/src/main/java/org/onap/aai/logging/LogFormatTools.java b/aai-core/src/main/java/org/onap/aai/logging/LogFormatTools.java index 702741b1..19650b65 100644 --- a/aai-core/src/main/java/org/onap/aai/logging/LogFormatTools.java +++ b/aai-core/src/main/java/org/onap/aai/logging/LogFormatTools.java @@ -25,6 +25,10 @@ import java.time.Instant; import java.time.ZoneOffset; import java.time.ZonedDateTime; import java.time.format.DateTimeFormatter; +import org.onap.aai.util.AAIConfig; +import org.onap.aai.util.AAIConstants; +import org.onap.aai.exceptions.AAIException; +import org.apache.commons.lang.exception.ExceptionUtils; public class LogFormatTools { @@ -43,4 +47,76 @@ public class LogFormatTools { public static long toTimestamp(String date) { return ZonedDateTime.parse(date, DTF).toInstant().toEpochMilli(); } + /** + * Gets the stack top. + * + * @param e the e + * @return the stack top + * @throws NumberFormatException the number format exception + * @throws AAIException the AAI exception + */ + public static String getStackTop(Throwable e) { + StringBuffer stackMessage = new StringBuffer(); + int maxStackTraceEntries = 10; + try { + maxStackTraceEntries = Integer.valueOf(AAIConfig.get(AAIConstants.LOGGING_MAX_STACK_TRACE_ENTRIES)); + } + catch (AAIException a) { + //ignore, use default + } + catch (NumberFormatException n) { + //ignore, use default + } + if (e != null) { + Throwable rootCause = ExceptionUtils.getRootCause(e); + if (rootCause != null) { + stackMessage.append("root cause=" + ExceptionUtils.getRootCause(e)); + StackTraceElement[] elements = rootCause.getStackTrace(); + int i = 0; + for (StackTraceElement element : elements) { + if (i < maxStackTraceEntries) { + stackMessage.append(" ClassName- "); + stackMessage.append(element.getClassName()); + stackMessage.append(" :LineNumber- "); + stackMessage.append(element.getLineNumber()); + stackMessage.append(" :MethodName- "); + stackMessage.append(element.getMethodName()); + } + i++; + } + } else if (e.getCause() != null) { + stackMessage.append("cause=" + e.getCause()); + StackTraceElement[] elements = e.getCause().getStackTrace(); + int i = 0; + for (StackTraceElement element : elements) { + if (i < maxStackTraceEntries) { + stackMessage.append(" ClassName- "); + stackMessage.append(element.getClassName()); + stackMessage.append(" :LineNumber- "); + stackMessage.append(element.getLineNumber()); + stackMessage.append(" :MethodName- "); + stackMessage.append(element.getMethodName()); + } + i++; + } + } else if (e.getStackTrace() != null) { + stackMessage.append("ex=" + e.toString()); + StackTraceElement[] elements = e.getStackTrace(); + int i = 0; + for (StackTraceElement element : elements) { + if (i < maxStackTraceEntries) { + stackMessage.append(" ClassName- "); + stackMessage.append(element.getClassName()); + stackMessage.append(" :LineNumber- "); + stackMessage.append(element.getLineNumber()); + stackMessage.append(" :MethodName- "); + stackMessage.append(element.getMethodName()); + } + i++; + } + } + } + return stackMessage.toString(); + } + } diff --git a/aai-core/src/main/java/org/onap/aai/logging/LoggingContext.java b/aai-core/src/main/java/org/onap/aai/logging/LoggingContext.java index 7d9dcce5..cb31bdde 100644 --- a/aai-core/src/main/java/org/onap/aai/logging/LoggingContext.java +++ b/aai-core/src/main/java/org/onap/aai/logging/LoggingContext.java @@ -58,6 +58,12 @@ public class LoggingContext { public static final String BUSINESS_PROCESS_ERROR = "500"; public static final String UNKNOWN_ERROR = "900"; + public static final Map responseMap = new HashMap(); + + static { + responseMap.put(SUCCESS, "Success"); + responseMap.put(UNKNOWN_ERROR, "Unknown error"); + } //ECOMP Specific Log Event Fields public static enum LoggingField { START_TIME("startTime"), @@ -126,9 +132,6 @@ public class LoggingContext { public static void requestId(String requestId) { try { - if(requestId == null){ - throw new IllegalArgumentException(); - } if (requestId.contains(":")) { String[] uuidParts = requestId.split(":"); requestId = uuidParts[0]; @@ -138,12 +141,13 @@ public class LoggingContext { final UUID generatedRequestUuid = UUID.randomUUID(); MDC.put(LoggingField.REQUEST_ID.toString(), generatedRequestUuid.toString()); LoggingContext.save(); - AAIException ex = new AAIException("AAI_7405", e); - String responseCode = Integer.toString(ex.getErrorObject().getHTTPResponseCode().getStatusCode()); + // set response code to 0 since we don't know what the outcome of this request is yet + String responseCode = LoggingContext.DATA_ERROR; LoggingContext.responseCode(responseCode); - - LOGGER.warn("Unable to use UUID " + requestId + " (Not formatted properly). Using generated UUID=" - + generatedRequestUuid); + LoggingContext.responseDescription("Unable to use UUID " + requestId + " (Not formatted properly) "); + LoggingContext.statusCode(StatusCode.ERROR); + + LOGGER.warn("Using generated UUID=" + generatedRequestUuid); LoggingContext.restore(); } @@ -196,6 +200,7 @@ public class LoggingContext { public static void successStatusFields() { responseCode(SUCCESS); statusCode(LoggingContext.StatusCode.COMPLETE); + responseDescription("Success"); } private static void serverIpAddress() { try { diff --git a/aai-core/src/main/java/org/onap/aai/logging/StopWatch.java b/aai-core/src/main/java/org/onap/aai/logging/StopWatch.java index b57387d5..4b05f1a6 100644 --- a/aai-core/src/main/java/org/onap/aai/logging/StopWatch.java +++ b/aai-core/src/main/java/org/onap/aai/logging/StopWatch.java @@ -34,7 +34,18 @@ public final class StopWatch { public static double stop() { return LoggingContext.stopWatchStop(); } - + public static void conditionalStart() { + if ( LoggingContext.isStopWatchStarted() ) { + return; + } + start(); + } + public static double stopIfStarted() { + if ( LoggingContext.isStopWatchStarted() ) { + return (stop()); + } + return (0); + } public static void clear() { LoggingContext.remove(LoggingField.STOP_WATCH_START.toString()); LoggingContext.remove(LoggingField.ELAPSED_TIME.toString()); diff --git a/aai-core/src/main/java/org/onap/aai/parsers/query/LegacyQueryParser.java b/aai-core/src/main/java/org/onap/aai/parsers/query/LegacyQueryParser.java index 9251be6b..10530d19 100644 --- a/aai-core/src/main/java/org/onap/aai/parsers/query/LegacyQueryParser.java +++ b/aai-core/src/main/java/org/onap/aai/parsers/query/LegacyQueryParser.java @@ -27,6 +27,7 @@ import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.Introspector; import org.onap.aai.introspection.Loader; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.parsers.uri.Parsable; import org.onap.aai.parsers.uri.URIParser; import org.onap.aai.parsers.uri.URIToObject; @@ -134,7 +135,8 @@ public class LegacyQueryParser extends QueryParser implements Parsable { Introspector child = obj.newIntrospectorInstanceOfNestedProperty(obj.getChildName()); this.handleUriKeys(child, uriKeys); } catch (AAIUnknownObjectException e) { - LOGGER.warn("Skipping container child " + obj.getChildName() + " (Unknown Object)", e); + LOGGER.warn("Skipping container child " + obj.getChildName() + " (Unknown Object) " + + LogFormatTools.getStackTop(e)); } } diff --git a/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToExtensionInformation.java b/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToExtensionInformation.java index 0b34a45f..868a7427 100644 --- a/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToExtensionInformation.java +++ b/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToExtensionInformation.java @@ -118,8 +118,15 @@ public class URIToExtensionInformation implements Parsable { */ public String getMethodName(HttpMethod httpMethod, boolean isPreprocess) { String result = "Dynamic"; - if (httpMethod.equals(HttpMethod.PUT)) { + /* + if (httpMethod.equals(HttpMethod.PUT) || httpMethod.equals(HttpMethod.PUT_EDGE)) { result += "Add"; + } + */ + if (httpMethod.equals(HttpMethod.PUT) ) { + result += "Add"; + } else if (httpMethod.equals(HttpMethod.PUT_EDGE)) { + result += "AddEdge"; } else if (httpMethod.equals(HttpMethod.DELETE)) { result += "Del"; } else { diff --git a/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToRelationshipObject.java b/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToRelationshipObject.java index cec55bc3..48a6324e 100644 --- a/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToRelationshipObject.java +++ b/aai-core/src/main/java/org/onap/aai/parsers/uri/URIToRelationshipObject.java @@ -134,7 +134,6 @@ public class URIToRelationshipObject implements Parsable { URI originalUri = parser.getOriginalURI(); URI relatedLink = new URI(this.baseURL + this.originalVersion + "/" + originalUri); - this.relationship.setValue("related-link", relatedLink); if (this.originalVersion.compareTo(Version.v10) >= 0) { //only return the path section of the URI past v10 relatedLink = new URI(relatedLink.getRawPath()); diff --git a/aai-core/src/main/java/org/onap/aai/query/builder/GraphTraversalBuilder.java b/aai-core/src/main/java/org/onap/aai/query/builder/GraphTraversalBuilder.java index 82079ad7..8156dd09 100644 --- a/aai-core/src/main/java/org/onap/aai/query/builder/GraphTraversalBuilder.java +++ b/aai-core/src/main/java/org/onap/aai/query/builder/GraphTraversalBuilder.java @@ -141,6 +141,37 @@ public abstract class GraphTraversalBuilder extends QueryBuilder { stepIndex++; return (QueryBuilder) this; } + + /** + * @{inheritDoc} + */ + @Override + public QueryBuilder getVerticesExcludeByProperty(String key, Object value) { + + // correct value call because the index is registered as an Integer + traversal.has(key, P.neq(this.correctObjectType(value))); + + stepIndex++; + return (QueryBuilder) this; + } + + /** + * @{inheritDoc} + */ + @Override + public QueryBuilder getVerticesExcludeByProperty(final String key, final List values) { + + //this is because the index is registered as an Integer + List correctedValues = new ArrayList<>(); + for (Object item : values) { + correctedValues.add(this.correctObjectType(item)); + } + + traversal.has(key, P.without(correctedValues)); + + stepIndex++; + return (QueryBuilder) this; + } /** * @{inheritDoc} @@ -414,6 +445,30 @@ public abstract class GraphTraversalBuilder extends QueryBuilder { return this; } + @Override + public QueryBuilder groupCount() { + this.traversal.groupCount(); + stepIndex++; + + return this; + } + + @Override + public QueryBuilder both() { + this.traversal.both(); + stepIndex++; + + return this; + } + + @Override + public QueryBuilder by(String name) { + this.traversal.by(name); + stepIndex++; + + return this; + } + /** * {@inheritDoc} */ diff --git a/aai-core/src/main/java/org/onap/aai/query/builder/GremlinQueryBuilder.java b/aai-core/src/main/java/org/onap/aai/query/builder/GremlinQueryBuilder.java index f2eaa91f..d87dac48 100644 --- a/aai-core/src/main/java/org/onap/aai/query/builder/GremlinQueryBuilder.java +++ b/aai-core/src/main/java/org/onap/aai/query/builder/GremlinQueryBuilder.java @@ -153,6 +153,47 @@ public abstract class GremlinQueryBuilder extends QueryBuilder { return (QueryBuilder) this; } + /** + * @{inheritDoc} + */ + @Override + public QueryBuilder getVerticesExcludeByProperty(String key, Object value) { + + String term = ""; + String predicate = "P.neq(#!#argument#!#)"; + if (value != null && !(value instanceof String) ) { + term = value.toString(); + } else { + term = "'" + value + "'"; + } + predicate = predicate.replace("#!#argument#!#", term); + list.add(".has('" + key + "', " + predicate + ")"); + stepIndex++; + return (QueryBuilder) this; + } + + /** + * @{inheritDoc} + */ + @Override + public QueryBuilder getVerticesExcludeByProperty(String key, List values) { + + String term = ""; + String predicate = "P.without(#!#argument#!#)"; + List arguments = new ArrayList<>(); + for (Object item : values) { + if (item != null && !(item instanceof String)) { + arguments.add(item.toString()); + } else { + arguments.add("'" + item + "'"); + } + } + String argument = Joiner.on(",").join(arguments); + predicate = predicate.replace("#!#argument#!#", argument); + list.add(".has('" + key + "', " + predicate + ")"); + stepIndex++; + return (QueryBuilder) this; + } /** * @{inheritDoc} @@ -274,7 +315,9 @@ public abstract class GremlinQueryBuilder extends QueryBuilder { } }); - if (inLabels.isEmpty() && !outLabels.isEmpty()) { + if(inLabels.isEmpty() && outLabels.isEmpty()) { + throw new NoEdgeRuleFoundException("no " + type.toString() + " edge rule between " + outType + " and " + inType ); + } else if (inLabels.isEmpty() && !outLabels.isEmpty()) { list.add(".out('" + String.join("','", outLabels) + "')"); } else if (outLabels.isEmpty() && !inLabels.isEmpty()) { list.add(".in('" + String.join("','", inLabels) + "')"); @@ -319,7 +362,9 @@ public abstract class GremlinQueryBuilder extends QueryBuilder { } }); - if (inLabels.isEmpty() && !outLabels.isEmpty()) { + if(inLabels.isEmpty() && outLabels.isEmpty()) { + throw new NoEdgeRuleFoundException("no " + type.toString() + " edge rule between " + outType + " and " + inType ); + } else if (inLabels.isEmpty() && !outLabels.isEmpty()) { list.add(".outE('" + String.join("','", outLabels) + "')"); } else if (outLabels.isEmpty() && !inLabels.isEmpty()) { list.add(".inE('" + String.join("','", inLabels) + "')"); @@ -449,6 +494,30 @@ public abstract class GremlinQueryBuilder extends QueryBuilder { return this; } + @Override + public QueryBuilder groupCount() { + this.list.add(".groupCount()"); + stepIndex++; + + return this; + } + + @Override + public QueryBuilder both() { + this.list.add(".both()"); + stepIndex++; + + return this; + } + + @Override + public QueryBuilder by(String name) { + this.list.add(".by('"+ name + "')"); + stepIndex++; + + return this; + } + /** * {@inheritDoc} */ diff --git a/aai-core/src/main/java/org/onap/aai/query/builder/QueryBuilder.java b/aai-core/src/main/java/org/onap/aai/query/builder/QueryBuilder.java index f5d47871..a51f592a 100644 --- a/aai-core/src/main/java/org/onap/aai/query/builder/QueryBuilder.java +++ b/aai-core/src/main/java/org/onap/aai/query/builder/QueryBuilder.java @@ -111,6 +111,33 @@ public abstract class QueryBuilder implements Iterator { */ public abstract QueryBuilder getVerticesByProperty(String key, List values); + /** + * Gets the vertices that are excluded by property. + * + * @param key the key + * @param value the value + * @return the vertices by property + */ + public abstract QueryBuilder getVerticesExcludeByProperty(String key, Object value); + + /** + * filters by all the values for this property and excludes the vertices + * @param key + * @param values + * @return vertices that match these values + */ + public QueryBuilder getVerticesExcludeByIndexedProperty(String key, List values) { + return this.getVerticesExcludeByProperty(key, values); + } + + /** + * filters by all the values for this property and excludes the vertices + * @param key + * @param values + * @return vertices that match these values + */ + public abstract QueryBuilder getVerticesExcludeByProperty(String key, List values); + /** * Gets the child vertices from parent. * @@ -369,6 +396,9 @@ public abstract class QueryBuilder implements Iterator { public abstract QueryBuilder as(String name); public abstract QueryBuilder select(String name); public abstract QueryBuilder until(QueryBuilder builder); + public abstract QueryBuilder groupCount(); + public abstract QueryBuilder by(String name); + public abstract QueryBuilder both(); /** * Used to prevent the traversal from repeating its path through the graph. diff --git a/aai-core/src/main/java/org/onap/aai/rest/RestHandlerService.java b/aai-core/src/main/java/org/onap/aai/rest/RestHandlerService.java new file mode 100644 index 00000000..9c037b30 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/rest/RestHandlerService.java @@ -0,0 +1,46 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.rest; + +import java.util.concurrent.Executors; +import java.util.concurrent.ThreadPoolExecutor; + +public class RestHandlerService { + private static RestHandlerService single_instance = null; + public ThreadPoolExecutor executor; + // private constructor restricted to this class itself + private RestHandlerService() + { + executor = (ThreadPoolExecutor) Executors.newFixedThreadPool(50); + } + /** + * Gets the single instance of RestHandlerService. + * + * @return single instance of RestHandlerService + */ + public static RestHandlerService getInstance() { + if (single_instance == null) { + single_instance = new RestHandlerService(); + } + return single_instance; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/rest/db/HttpEntry.java b/aai-core/src/main/java/org/onap/aai/rest/db/HttpEntry.java index 0d89a74c..d6bf3625 100644 --- a/aai-core/src/main/java/org/onap/aai/rest/db/HttpEntry.java +++ b/aai-core/src/main/java/org/onap/aai/rest/db/HttpEntry.java @@ -30,7 +30,10 @@ import java.net.URISyntaxException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.Set; +import java.util.Map.Entry; +import java.util.concurrent.TimeUnit; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; @@ -48,6 +51,8 @@ import org.onap.aai.dbmap.DBConnectionType; import org.onap.aai.domain.responseMessage.AAIResponseMessage; import org.onap.aai.domain.responseMessage.AAIResponseMessageDatum; import org.onap.aai.exceptions.AAIException; +import org.onap.aai.extensions.AAIExtensionMap; +import org.onap.aai.extensions.ExtensionController; import org.onap.aai.introspection.Introspector; import org.onap.aai.introspection.Loader; import org.onap.aai.introspection.LoaderFactory; @@ -57,6 +62,7 @@ import org.onap.aai.introspection.ModelType; import org.onap.aai.introspection.Version; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LoggingContext; import org.onap.aai.parsers.query.QueryParser; import org.onap.aai.parsers.uri.URIToExtensionInformation; import org.onap.aai.rest.ueb.UEBNotification; @@ -82,6 +88,7 @@ import com.thinkaurelius.titan.core.TitanException; public class HttpEntry { private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(HttpEntry.class); + private static final String TARGET_ENTITY = "DB"; private final ModelType introspectorFactoryType; @@ -175,6 +182,7 @@ public class HttpEntry { */ public Pair>> process (List requests, String sourceOfTruth, boolean enableResourceVersion) throws AAIException { DBSerializer serializer = new DBSerializer(version, dbEngine, introspectorFactoryType, sourceOfTruth); + String methodName = "process"; Response response = null; Status status = Status.NOT_FOUND; Introspector obj = null; @@ -191,16 +199,25 @@ public class HttpEntry { QueryEngine queryEngine = dbEngine.getQueryEngine(); int maxRetries = 10; int retry = 0; + + LoggingContext.save(); for (DBRequest request : requests) { try { for (retry = 0; retry < maxRetries; ++retry) { try { method = request.getMethod(); + + LoggingContext.targetEntity(TARGET_ENTITY); + LoggingContext.targetServiceName(methodName + " " + method); + obj = request.getIntrospector(); query = request.getParser(); transactionId = request.getTransactionId(); uriTemp = request.getUri().getRawPath().replaceFirst("^v\\d+/", ""); uri = UriBuilder.fromPath(uriTemp).build(); + + LoggingContext.startTime(); + List vertices = query.getQueryBuilder().toList(); boolean isNewVertex = false; String outputMediaType = getMediaType(request.getHeaders().getAcceptableMediaTypes()); @@ -219,8 +236,10 @@ public class HttpEntry { } if (vertices.size() > 1 && processSingle && !method.equals(HttpMethod.GET)) { if (method.equals(HttpMethod.DELETE)) { + LoggingContext.restoreIfPossible(); throw new AAIException("AAI_6138"); } else { + LoggingContext.restoreIfPossible(); throw new AAIException("AAI_6137"); } } @@ -254,8 +273,12 @@ public class HttpEntry { case GET: String nodeOnly = params.getFirst("nodes-only"); boolean isNodeOnly = nodeOnly != null; - obj = this.getObjectFromDb(vertices, serializer, query, obj, request.getUri(), depth, isNodeOnly, cleanUp); + + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs(),TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); + if (obj != null) { status = Status.OK; MarshallerProperties properties; @@ -282,11 +305,20 @@ public class HttpEntry { if (query.isDependent()) { relatedObjects = this.getRelatedObjects(serializer, queryEngine, v); } + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs() + + (long)queryEngine.getDBTimeMsecs(), TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); notification.createNotificationEvent(transactionId, sourceOfTruth, status, uri, obj, relatedObjects); + break; case PUT_EDGE: serializer.touchStandardVertexProperties(v, false); serializer.createEdge(obj, v); + + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs(),TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); status = Status.OK; break; case MERGE_PATCH: @@ -319,8 +351,15 @@ public class HttpEntry { if (query.isDependent()) { relatedObjects = this.getRelatedObjects(serializer, queryEngine, v); } + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs() + + (long)queryEngine.getDBTimeMsecs(), TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); notification.createNotificationEvent(transactionId, sourceOfTruth, status, uri, patchedObj, relatedObjects); } catch (IOException | JsonPatchException e) { + + LOGGER.info ("Caught exception: " + e.getMessage()); + LoggingContext.restoreIfPossible(); throw new AAIException("AAI_3000", "could not perform patch operation"); } break; @@ -330,13 +369,58 @@ public class HttpEntry { if (query.isDependent()) { relatedObjects = this.getRelatedObjects(serializer, queryEngine, v); } + /* + * Find all Delete-other-vertex vertices and create structure for notify + * findDeleatble also returns the startVertex v and we dont want to create + * duplicate notification events for the same + * So remove the startvertex first + */ + + List deletableVertices = dbEngine.getQueryEngine().findDeletable(v); + Long vId = (Long) v.id(); + + /* + * I am assuming vertexId cant be null + */ + deletableVertices.removeIf(s -> vId.equals(s.id())); + boolean isDelVerticesPresent = !deletableVertices.isEmpty(); + Map deleteObjects = new HashMap<>(); + Map uriMap = new HashMap<>(); + Map> deleteRelatedObjects = new HashMap<>(); + + if(isDelVerticesPresent){ + deleteObjects = this.buildIntrospectorObjects(serializer, deletableVertices); + + uriMap = this.buildURIMap(serializer, deleteObjects); + deleteRelatedObjects = this.buildRelatedObjects(serializer, queryEngine, deleteObjects); + } + serializer.delete(v, resourceVersion, enableResourceVersion); + + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs() + + (long)queryEngine.getDBTimeMsecs(), TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); status = Status.NO_CONTENT; notification.createNotificationEvent(transactionId, sourceOfTruth, status, uri, obj, relatedObjects); + + /* + * Notify delete-other-v candidates + */ + + if(isDelVerticesPresent){ + this.buildNotificationEvent(sourceOfTruth, status, transactionId, notification, deleteObjects, + uriMap, deleteRelatedObjects); + } + break; case DELETE_EDGE: serializer.touchStandardVertexProperties(v, false); serializer.deleteEdge(obj, v); + + LoggingContext.elapsedTime((long)serializer.getDBTimeMsecs(),TimeUnit.MILLISECONDS); + LOGGER.info ("Completed"); + LoggingContext.restoreIfPossible(); status = Status.NO_CONTENT; break; default: @@ -370,25 +454,27 @@ public class HttpEntry { break; } catch (TitanException e) { this.dbEngine.rollback(); + + LOGGER.info ("Caught exception: " + e.getMessage()); + LoggingContext.restoreIfPossible(); AAIException ex = new AAIException("AAI_6142", e); ErrorLogHelper.logException(ex); - Thread.sleep((retry + 1) * 20); + Thread.sleep((retry + 1) * 20L); this.dbEngine.startTransaction(); queryEngine = dbEngine.getQueryEngine(); serializer = new DBSerializer(version, dbEngine, introspectorFactoryType, sourceOfTruth); } - if (retry == maxRetries) { throw new AAIException("AAI_6134"); } } } catch (AAIException e) { success = false; - ArrayList templateVars = new ArrayList(); + ArrayList templateVars = new ArrayList<>(); templateVars.add(request.getMethod().toString()); //GET, PUT, etc - templateVars.add(request.getUri().getPath().toString()); + templateVars.add(request.getUri().getPath()); templateVars.addAll(e.getTemplateVars()); - + ErrorLogHelper.logException(e); response = Response .status(e.getErrorObject().getHTTPResponseCode()) .entity(ErrorLogHelper.getRESTAPIErrorResponse(request.getHeaders().getAcceptableMediaTypes(), e, templateVars)) @@ -403,7 +489,7 @@ public class HttpEntry { ArrayList templateVars = new ArrayList(); templateVars.add(request.getMethod().toString()); //GET, PUT, etc templateVars.add(request.getUri().getPath().toString()); - + ErrorLogHelper.logException(ex); response = Response .status(ex.getErrorObject().getHTTPResponseCode()) .entity(ErrorLogHelper.getRESTAPIErrorResponse(request.getHeaders().getAcceptableMediaTypes(), ex, templateVars)) @@ -415,10 +501,10 @@ public class HttpEntry { } notification.triggerEvents(); - Pair>> tuple = Pair.with(success, responses); - return tuple; + return Pair.with(success, responses); } + /** * Gets the media type. * @@ -562,5 +648,88 @@ public class HttpEntry { return relatedVertices; } + + private Map buildIntrospectorObjects(DBSerializer serializer, Iterable vertices) { + Map deleteObjectMap = new HashMap<>(); + for (Vertex vertex : vertices) { + try { + // deleteObjectMap.computeIfAbsent(vertex, s -> + // serializer.getLatestVersionView(vertex)); + Introspector deleteObj = serializer.getLatestVersionView(vertex); + deleteObjectMap.put(vertex, deleteObj); + } catch (UnsupportedEncodingException | AAIException e) { + LOGGER.warn("Unable to get Introspctor Objects, Just continue"); + continue; + } + + } + + return deleteObjectMap; + + } + + private Map buildURIMap(DBSerializer serializer, Map introSpector) { + Map uriMap = new HashMap<>(); + for (Map.Entry entry : introSpector.entrySet()) { + URI uri; + try { + uri = serializer.getURIForVertex(entry.getKey()); + if (null != entry.getValue()) + uriMap.put(entry.getValue().getObjectId(), uri); + } catch (UnsupportedEncodingException e) { + LOGGER.warn("Unable to get URIs, Just continue"); + continue; + } + + } + + return uriMap; + + } + + private Map> buildRelatedObjects(DBSerializer serializer, + QueryEngine queryEngine, Map introSpector) { + + Map> relatedObjectsMap = new HashMap<>(); + for (Map.Entry entry : introSpector.entrySet()) { + try { + HashMap relatedObjects = this.getRelatedObjects(serializer, queryEngine, + entry.getKey()); + if (null != entry.getValue()) + relatedObjectsMap.put(entry.getValue().getObjectId(), relatedObjects); + } catch (IllegalAccessException | IllegalArgumentException + | InvocationTargetException | SecurityException | InstantiationException | NoSuchMethodException + | UnsupportedEncodingException | AAIException | URISyntaxException e) { + LOGGER.warn("Unable to get realted Objects, Just continue"); + continue; + } + + } + + return relatedObjectsMap; + + } + + private void buildNotificationEvent(String sourceOfTruth, Status status, String transactionId, + UEBNotification notification, Map deleteObjects, Map uriMap, + Map> deleteRelatedObjects) { + for (Map.Entry entry : deleteObjects.entrySet()) { + try { + String vertexObjectId = ""; + + if (null != entry.getValue()) { + vertexObjectId = entry.getValue().getObjectId(); + + if (uriMap.containsKey(vertexObjectId) && deleteRelatedObjects.containsKey(vertexObjectId)) + notification.createNotificationEvent(transactionId, sourceOfTruth, status, + uriMap.get(vertexObjectId), entry.getValue(), deleteRelatedObjects.get(vertexObjectId)); + } + } catch (UnsupportedEncodingException | AAIException e) { + + LOGGER.warn("Error in sending otification"); + } + } + } + } diff --git a/aai-core/src/main/java/org/onap/aai/restcore/RESTAPI.java b/aai-core/src/main/java/org/onap/aai/restcore/RESTAPI.java index f26ac197..9f13096b 100644 --- a/aai-core/src/main/java/org/onap/aai/restcore/RESTAPI.java +++ b/aai-core/src/main/java/org/onap/aai/restcore/RESTAPI.java @@ -25,6 +25,14 @@ import java.io.UnsupportedEncodingException; import java.net.URI; import java.util.ArrayList; import java.util.List; +import java.util.Map; +import java.util.HashMap; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.Callable; +import java.util.concurrent.TimeoutException; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; @@ -77,7 +85,6 @@ public class RESTAPI { * Gets the from app id. * * @param headers the headers - * @param logline the logline * @return the from app id * @throws AAIException the AAI exception */ @@ -105,7 +112,6 @@ public class RESTAPI { * Gets the trans id. * * @param headers the headers - * @param logline the logline * @return the trans id * @throws AAIException the AAI exception */ @@ -194,6 +200,7 @@ public class RESTAPI { templateVars.add(info.getPath().toString()); templateVars.addAll(e.getTemplateVars()); + ErrorLogHelper.logException(e); return Response .status(e.getErrorObject().getHTTPResponseCode()) .entity(ErrorLogHelper.getRESTAPIErrorResponseWithLogging(headers.getAcceptableMediaTypes(), e, templateVars)) @@ -206,7 +213,6 @@ public class RESTAPI { * @param obj the obj * @param loader the loader * @param uri the uri - * @param validateRequired the validate required * @throws AAIException the AAI exception * @throws UnsupportedEncodingException the unsupported encoding exception */ @@ -255,12 +261,15 @@ public class RESTAPI { throw new AAIException("AAI_4009", "X-FromAppId is not set"); } + DBConnectionType type = DBConnectionType.REALTIME; boolean isRealTimeClient = AAIConfig.get("aai.realtime.clients", "").contains(fromAppId); if (isRealTimeClient || realTime != null) { - return DBConnectionType.REALTIME; + type = DBConnectionType.REALTIME; } else { - return DBConnectionType.CACHED; + type = DBConnectionType.CACHED; } + + return type; } /** @@ -276,4 +285,116 @@ public class RESTAPI { } + /** + * Returns the app specific timeout in milliseconds, -1 overrides the timeout for an app + * + * @param sot + * @param appTimeouts + * @param defaultTimeout + * @return integer timeout in or -1 to bypass + * @throws AAIException + */ + + public int getTimeoutLimit(String sot, String appTimeouts, String defaultTimeout) throws AAIException{ + String[] ignoreAppIds = (appTimeouts).split("\\|"); + int appLimit = Integer.parseInt(defaultTimeout); + final Map m = new HashMap(); + if(ignoreAppIds != null) { + for (int i = 0; i < ignoreAppIds.length; i++) { + String[] vals = ignoreAppIds[i].split(","); + m.put(vals[0], Integer.parseInt(vals[1])); + } + if (m.get(sot) != null) { + appLimit = m.get(sot); + } + } + return appLimit; + } + + /** + * Returns whether time out is enabled + * @param sot + * @param isEnabled + * @param appTimeouts + * @param defaultTimeout + * @return boolean of whether the timeout is enabled + * @throws AAIException + */ + public boolean isTimeoutEnabled(String sot, String isEnabled, String appTimeouts, String defaultTimeout) throws AAIException{ + Boolean isTimeoutEnabled = Boolean.parseBoolean(isEnabled); + int ata = -1; + if(isTimeoutEnabled) { + ata = getTimeoutLimit(sot, appTimeouts, defaultTimeout); + } + return isTimeoutEnabled && (ata > -1); + } + + /** + * Executes the process thread and watches the future for the timeout + * @param handler + * @param sourceOfTruth + * @param appTimeoutLimit + * @param defaultTimeoutLimit + * @param method + * @param headers + * @param info + * @return the response + */ + + public Response executeProcess(Future handler, String sourceOfTruth, String appTimeoutLimit, String defaultTimeoutLimit, HttpMethod method, HttpHeaders headers, UriInfo info){ + Response response = null; + int timeoutLimit = 0; + try { + timeoutLimit = getTimeoutLimit(sourceOfTruth, appTimeoutLimit, defaultTimeoutLimit); + response = handler.get(timeoutLimit, TimeUnit.MILLISECONDS); + } catch (TimeoutException e) { + AAIException ex = new AAIException("AAI_7406", String.format("Timeout limit of %s seconds reached.", timeoutLimit/1000)); + response = consumerExceptionResponseGenerator(headers, info, method, ex); + handler.cancel(true); + } catch (Exception e) { + AAIException ex = new AAIException("AAI_4000", e); + response = consumerExceptionResponseGenerator(headers, info, method, ex); + } + return response; + } + + /** + * runner sets up the timer logic and invokes it + * @param toe + * @param tba + * @param tdl + * @param headers + * @param info + * @param httpMethod + * @param c + * @return the response + */ + public Response runner(String toe, String tba, String tdl, HttpHeaders headers, UriInfo info, HttpMethod httpMethod, Callable c){ + Response response = null; + Future handler = null; + ExecutorService executor = null; + try { + String timeoutEnabled = AAIConfig.get(toe); + String timeoutByApp = AAIConfig.get(tba); + String timeoutDefaultLimit = AAIConfig.get(tdl); + String sourceOfTruth = headers.getRequestHeaders().getFirst("X-FromAppId"); + if (isTimeoutEnabled(sourceOfTruth, timeoutEnabled, timeoutByApp, timeoutDefaultLimit)) { + executor = Executors.newSingleThreadExecutor(); + handler = executor.submit(c); + response = executeProcess(handler, sourceOfTruth, timeoutByApp, timeoutDefaultLimit, httpMethod, headers, info); + } else { + response = (Response) c.call(); + } + }catch(Exception e){ + AAIException ex = new AAIException("AAI_4000", e); + response = consumerExceptionResponseGenerator(headers, info, httpMethod, ex); + }finally{ + if(executor != null && handler != null){ + executor.shutdownNow(); + } + } + return response; + } + } + diff --git a/aai-core/src/main/java/org/onap/aai/restcore/util/EdgeRuleBean.java b/aai-core/src/main/java/org/onap/aai/restcore/util/EdgeRuleBean.java new file mode 100644 index 00000000..cd175e38 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/restcore/util/EdgeRuleBean.java @@ -0,0 +1,95 @@ +/*- + * ============LICENSE_START======================================================= + * org.openecomp.aai + * ================================================================================ + * Copyright (C) 2017 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.restcore.util; + +public class EdgeRuleBean { + private String from; + private String to; + private String label; + private String direction; + private String multiplicity; + private String lineage; + private String preventDelete; + private String deleteOtherV; + private String svcInfra; + private String defaultVal; + + public String getFrom() { + return from; + } + public void setFrom(String from) { + this.from = from; + } + public String getTo() { + return to; + } + public void setTo(String to) { + this.to = to; + } + public String getLabel() { + return label; + } + public void setLabel(String label) { + this.label = label; + } + public String getDirection() { + return direction; + } + public void setDirection(String direction) { + this.direction = direction; + } + public String getMultiplicity() { + return multiplicity; + } + public void setMultiplicity(String multiplicity) { + this.multiplicity = multiplicity; + } + public String getDeleteOtherV() { + return deleteOtherV; + } + public void setDeleteOtherV(String deleteOtherV) { + this.deleteOtherV = deleteOtherV; + } + public String getPreventDelete() { + return preventDelete; + } + public void setPreventDelete(String preventDelete) { + this.preventDelete = preventDelete; + } + public String getSvcInfra() { + return svcInfra; + } + public void setSvcInfra(String svcInfra) { + this.svcInfra = svcInfra; + } + public String getLineage() { + return lineage; + } + public void setLineage(String lineage) { + this.lineage = lineage; + } + public String getDefault() { + return defaultVal; + } + public void setDefault(String defaultVal) { + this.defaultVal = defaultVal; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/restcore/util/GenerateEdgeRules.java b/aai-core/src/main/java/org/onap/aai/restcore/util/GenerateEdgeRules.java index 1b854667..e1660ab3 100644 --- a/aai-core/src/main/java/org/onap/aai/restcore/util/GenerateEdgeRules.java +++ b/aai-core/src/main/java/org/onap/aai/restcore/util/GenerateEdgeRules.java @@ -21,8 +21,6 @@ */ package org.onap.aai.restcore.util; -import com.att.eelf.configuration.EELFLogger; -import com.att.eelf.configuration.EELFManager; import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; @@ -30,108 +28,162 @@ import freemarker.template.TemplateException; import java.io.*; import java.util.*; -public class GenerateEdgeRules { +import org.onap.aai.serialization.db.EdgeRules; +import org.onap.aai.introspection.Version; - private static final EELFLogger LOG = EELFManager.getInstance().getLogger(GenerateEdgeRules.class); +public class GenerateEdgeRules { public static void main(String[] args) throws IOException, TemplateException { - String filename = "/AAI8032.csv"; + String filename = "/edgeLabelMigration.csv"; InputStream inputStream = GenerateEdgeRules.class.getResourceAsStream(filename); Map headers = new HashMap<>(); - Map edgeRulesMap = new TreeMap(); - List> edgeRules = new ArrayList<>(); - try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) { + List rulesToWriteV12 = new ArrayList<>(); + List rulesToWriteV7 = new ArrayList<>(); + List rulesToWriteV8 = new ArrayList<>(); + List rulesToWriteV9 = new ArrayList<>(); + List rulesToWriteV10 = new ArrayList<>(); + List rulesToWriteV11 = new ArrayList<>(); - String line = null; + ArrayList rulesWeAlreadyHave = new ArrayList (); - int rowNum = 0; + EdgeRules rulesV8 = EdgeRules.getInstance(Version.v8); + EdgeRules rulesV9 = EdgeRules.getInstance(Version.v9); + EdgeRules rulesV10 = EdgeRules.getInstance(Version.v10); + EdgeRules rulesV11 = EdgeRules.getInstance(Version.v11); - // Retrieve the header line to map the indexes to their column names + try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) { + String line = null; + int rowNum = 0; while ((line = reader.readLine()) != null) { - - if (rowNum == 0) { + if (rowNum == 0) { headers = retrieveHeaderMap(line); - } else { - String[] columns = line.split(","); - - String originalNode = columns[headers.get("Orig NodeA|NodeB")]; - String finalNode = columns[headers.get("Final NodeA|NodeB")]; - String originalEdge = columns[headers.get("Orig EdgeLabel")]; - String finalEdge = columns[headers.get("Final EdgeLabel")]; - - String lineage = columns[headers.get("Final Lineage")]; - String originalParent = columns[headers.get("Orig ParentOf")]; - String usesResource = columns[headers.get("Revised UsesResource")]; - String hasDelTarget = columns[headers.get("Revised hasDelTarget")]; - String svcInfra = columns[headers.get("Final SVC-INFRA")]; - String svcInfraRev = ""; - - if(usesResource.equals("T")) - usesResource = "true"; - else if(usesResource.equals("F")) - usesResource = "false"; - - if (hasDelTarget.equals("T") || hasDelTarget.equals("AB")) { - hasDelTarget = "true"; - } else if (hasDelTarget.equals("F")) { - hasDelTarget = "false"; + } + else { + EdgeRuleBean data = new EdgeRuleBean(); + String[] columns = line.split(","); + String oldNodeA = columns[headers.get("from")]; + String oldNodeB = columns[headers.get("to")]; + String oldEdgeLabel = columns[headers.get("label")]; + + String nodeA = columns[headers.get("new from")]; + data.setFrom(nodeA); + String nodeB = columns[headers.get("new to")]; + data.setTo(nodeB); + + String edgeLabel = columns[headers.get("new label")]; + data.setLabel( edgeLabel ); + + + // Note: it is assumed that if we know the two NodeTypes and the edgeLabel, we can + // uniquely identify an edgeRule -- so if that key is found twice, it is a + // problem with our CSV file. Note -we check with the nodeTypes in both directions. + String key1 = nodeA + "|" + nodeB + "|" + edgeLabel; + String key2 = nodeB + "|" + nodeA + "|" + edgeLabel; + if( rulesWeAlreadyHave.contains(key1) ){ + throw new Exception ("Duplicate rule found for [" + key1 + "] -- please fix the CSV file. "); } - - if (svcInfra.equals("T")) { - svcInfra = "true"; - } else if (svcInfra.equals("F")) { - svcInfra = "false"; - } else if (svcInfra.equals("R")) { - svcInfra = "reverse"; + else if( rulesWeAlreadyHave.contains(key2) ){ + throw new Exception ("Duplicate rule found for [" + key2 + "] -- please fix the CSV file. "); } + else { + rulesWeAlreadyHave.add(key1); + rulesWeAlreadyHave.add(key2); + } + + String direction = columns[headers.get("new direction")]; + data.setDirection(direction); + + String multiplicity = columns[headers.get("new multiplicity")]; + data.setMultiplicity(multiplicity); - if (originalParent.equals("T")) { - if (lineage.trim().equalsIgnoreCase("CHILD")) { - lineage = "true"; - } else if (lineage.trim().equalsIgnoreCase("PARENT")) { - lineage = "reverse"; - } - } else { - lineage = "false"; + String lineage = columns[headers.get("new contains-other-v")]; + data.setLineage(lineage); + + String deleteOtherV = columns[headers.get("new delete-other-v")]; + data.setDeleteOtherV(deleteOtherV); + + String svcInfra = columns[headers.get("new SVC-INFRA")]; + data.setSvcInfra(svcInfra); + + String prevDel = columns[headers.get("new prevent-delete")]; + data.setPreventDelete(prevDel); + + String defaultVal = columns[headers.get("new default")]; + if( defaultVal.equals("T") ){ + data.setDefault("true"); } + else if( defaultVal.equals("F") ){ + data.setDefault("false"); + } + + rulesToWriteV12.add(data); - Map edgeMap = new HashMap(); + if( rulesV8.hasEdgeRule(oldNodeA, oldNodeB, oldEdgeLabel) ){ + rulesToWriteV8.add(data); + } - edgeMap.put("lineage", lineage); - edgeMap.put("usesResource", usesResource); - edgeMap.put("hasDelTarget", hasDelTarget); - edgeMap.put("SVC-INFRA", svcInfra); - edgeMap.put("SVC-INFRA-REV", svcInfraRev); - edgeMap.put("nodes", finalNode); - edgeMap.put("edge", finalEdge); - edgeMap.put("direction", columns[headers.get("Orig Direction")]); - edgeMap.put("multiplicity", columns[headers.get("Revised Multiplicity")]); + if( rulesV9.hasEdgeRule(oldNodeA, oldNodeB, oldEdgeLabel) ){ + rulesToWriteV9.add(data); + } - edgeRules.add(edgeMap); + if( rulesV10.hasEdgeRule(oldNodeA, oldNodeB, oldEdgeLabel) ){ + rulesToWriteV10.add(data); + } + if( rulesV11.hasEdgeRule(oldNodeA, oldNodeB, oldEdgeLabel) ){ + rulesToWriteV11.add(data); + } } ++rowNum; } + + Configuration configuration = new Configuration(); + Template template = configuration.getTemplate("src/main/resources/edgerulesTemplate.ftlh"); + Writer file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v12.json")); + Map> wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV12); + template.process(wrappedRules, file); + file.close(); + + file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v7.json")); + wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV7); + template.process(wrappedRules, file); + file.close(); + + file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v8.json")); + wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV8); + template.process(wrappedRules, file); + file.close(); + + + file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v9.json")); + wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV9); + template.process(wrappedRules, file); + file.close(); + + file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v10.json")); + wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV10); + template.process(wrappedRules, file); + file.close(); + + file = new FileWriter(new File("src/main/resources/EdgeRulesWithNewLabels_v11.json")); + wrappedRules = new HashMap<>(); + wrappedRules.put("wrappedRules", rulesToWriteV11); + template.process(wrappedRules, file); + file.close(); + } catch(Exception ex){ ex.printStackTrace(); } - edgeRulesMap.put("edgeRules", edgeRules); - - Collections.sort(edgeRules, new Comparator>() { - @Override - public int compare(Map o1, Map o2) { - return o1.get("nodes").compareTo(o2.get("nodes")); - } - }); - Configuration configuration = new Configuration(); - Template template = configuration.getTemplate("ajsc-aai/src/main/resources/EdgeRules.ftl"); - Writer file = new FileWriter(new File("ajsc-aai/src/main/resources" + "/" + "EdgeRules.txt")); - template.process(edgeRulesMap, file); } private static Map retrieveHeaderMap(String line){ @@ -146,7 +198,7 @@ public class GenerateEdgeRules { int index = 0; for(String columnName : columnNames){ - map.put(columnName, index++); + map.put(columnName, index++); } return map; diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/DBSerializer.java b/aai-core/src/main/java/org/onap/aai/serialization/db/DBSerializer.java index cd48fc6a..8e1bf968 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/db/DBSerializer.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/DBSerializer.java @@ -1,73 +1,48 @@ -/*- +/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright Ā© 2017 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 - * + * + * 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.serialization.db; -import java.io.UnsupportedEncodingException; -import java.lang.reflect.Array; -import java.lang.reflect.InvocationTargetException; -import java.net.MalformedURLException; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.Iterator; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.Set; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; - -import javax.ws.rs.core.UriBuilder; - +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import com.google.common.base.CaseFormat; +import com.thinkaurelius.titan.core.SchemaViolationException; import org.apache.commons.collections.IteratorUtils; 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.Direction; -import org.apache.tinkerpop.gremlin.structure.Edge; -import org.apache.tinkerpop.gremlin.structure.Element; -import org.apache.tinkerpop.gremlin.structure.Vertex; -import org.apache.tinkerpop.gremlin.structure.VertexProperty; +import org.apache.tinkerpop.gremlin.structure.*; import org.javatuples.Pair; import org.javatuples.Triplet; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.exceptions.AAIException; -import org.onap.aai.introspection.Introspector; -import org.onap.aai.introspection.IntrospectorFactory; -import org.onap.aai.introspection.Loader; -import org.onap.aai.introspection.LoaderFactory; -import org.onap.aai.introspection.ModelType; -import org.onap.aai.introspection.PropertyPredicates; -import org.onap.aai.introspection.Version; +import org.onap.aai.introspection.*; import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import org.onap.aai.introspection.sideeffect.DataCopy; import org.onap.aai.introspection.sideeffect.DataLinkReader; import org.onap.aai.introspection.sideeffect.DataLinkWriter; import org.onap.aai.introspection.sideeffect.SideEffectRunner; import org.onap.aai.logging.ErrorLogHelper; +import org.onap.aai.logging.LogFormatTools; import org.onap.aai.parsers.query.QueryParser; import org.onap.aai.parsers.uri.URIParser; import org.onap.aai.parsers.uri.URIToRelationshipObject; @@ -82,11 +57,22 @@ import org.onap.aai.util.AAIApiServerURLBase; import org.onap.aai.util.AAIConfig; import org.onap.aai.util.AAIConstants; import org.onap.aai.workarounds.NamingExceptions; +import org.onap.aai.logging.StopWatch; -import com.att.eelf.configuration.EELFLogger; -import com.att.eelf.configuration.EELFManager; -import com.google.common.base.CaseFormat; -import com.thinkaurelius.titan.core.SchemaViolationException; +import javax.ws.rs.core.UriBuilder; +import java.io.UnsupportedEncodingException; +import java.lang.reflect.Array; +import java.lang.reflect.InvocationTargetException; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.*; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.regex.Matcher; +import java.util.regex.Pattern; public class DBSerializer { @@ -100,6 +86,7 @@ public class DBSerializer { private final EdgeRules edgeRules = EdgeRules.getInstance(); private final Loader loader; private final String baseURL; + private double dbTimeMsecs = 0; /** * Instantiates a new DB serializer. * @@ -133,6 +120,7 @@ public class DBSerializer { if (isNewVertex) { v.property(AAIProperties.SOURCE_OF_TRUTH, this.sourceOfTruth); v.property(AAIProperties.CREATED_TS, timeNowInSec); + v.property(AAIProperties.AAI_UUID, UUID.randomUUID().toString()); } v.property(AAIProperties.RESOURCE_VERSION, timeNowInSec ); v.property(AAIProperties.LAST_MOD_TS, timeNowInSec); @@ -158,11 +146,15 @@ public class DBSerializer { * @throws AAIException the AAI exception */ public Vertex createNewVertex(Introspector wrappedObject) { - - - Vertex v = this.engine.tx().addVertex(); - touchStandardVertexProperties(wrappedObject.getDbName(), v, true); - + Vertex v; + try { + StopWatch.conditionalStart(); + v = this.engine.tx().addVertex(); + touchStandardVertexProperties(wrappedObject.getDbName(), v, true); + } + finally { + dbTimeMsecs += StopWatch.stopIfStarted(); + } return v; } @@ -205,7 +197,7 @@ public class DBSerializer { * @throws AAIUnknownObjectException */ public void serializeToDb(Introspector obj, Vertex v, QueryParser uriQuery, String identifier, String requestContext) throws AAIException, UnsupportedEncodingException { - + StopWatch.conditionalStart(); try { if (uriQuery.isDependent()) { //try to find the parent @@ -214,6 +206,7 @@ public class DBSerializer { Vertex parent = vertices.get(0); this.reflectDependentVertex(parent, v, obj, requestContext); } else { + dbTimeMsecs += StopWatch.stopIfStarted(); throw new AAIException("AAI_6114", "No parent Node of type " + uriQuery.getParentResultType() + " for " + identifier); } } else { @@ -221,17 +214,20 @@ public class DBSerializer { } } catch (SchemaViolationException e) { + dbTimeMsecs += StopWatch.stopIfStarted(); throw new AAIException("AAI_6117", e); } - + dbTimeMsecs += StopWatch.stopIfStarted(); } public void serializeSingleVertex(Vertex v, Introspector obj, String requestContext) throws UnsupportedEncodingException, AAIException { + StopWatch.conditionalStart(); try { boolean isTopLevel = obj.isTopLevel(); if (isTopLevel) { v.property(AAIProperties.AAI_URI, obj.getURI()); } + processObject(obj, v, requestContext); if (!isTopLevel) { URI uri = this.getURIForVertex(v); @@ -246,6 +242,9 @@ public class DBSerializer { } catch (SchemaViolationException e) { throw new AAIException("AAI_6117", e); } + finally { + dbTimeMsecs += StopWatch.stopIfStarted(); + } } /** @@ -555,7 +554,8 @@ public class DBSerializer { String parentUri = parent.property(AAIProperties.AAI_URI).orElse(null); if (parentUri != null) { - String uri = obj.getURI(); + String uri; + uri = obj.getURI(); child.property(AAIProperties.AAI_URI, parentUri + uri); } processObject(obj, child, requestContext); @@ -565,7 +565,8 @@ public class DBSerializer { if (e == null) { String canBeLinked = obj.getMetadata(ObjectMetadata.CAN_BE_LINKED); if (canBeLinked != null && canBeLinked.equals("true")) { - boolean isFirst = !this.engine.getQueryBuilder(parent).createEdgeTraversal(EdgeType.TREE, parent, obj).hasNext(); + Loader ldrForCntxt = LoaderFactory.createLoaderForVersion(introspectionType, getVerForContext(requestContext)); + boolean isFirst = !this.engine.getQueryBuilder(ldrForCntxt, parent).createEdgeTraversal(EdgeType.TREE, parent, obj).hasNext(); if (isFirst) { child.property(AAIProperties.LINKED, true); } @@ -575,6 +576,16 @@ public class DBSerializer { return child; } + + private Version getVerForContext(String requestContext) { + Pattern pattern = Pattern.compile("v[0-9]+"); + Matcher m = pattern.matcher(requestContext); + if (!m.find()) { + return this.version; + } else { + return Version.valueOf(requestContext); + } + } /** * Db to object. @@ -597,14 +608,15 @@ public class DBSerializer { * @throws URISyntaxException */ public Introspector dbToObject(List vertices, final Introspector obj, int depth, boolean nodeOnly, String cleanUp) throws UnsupportedEncodingException, AAIException { - final int internalDepth; if (depth == Integer.MAX_VALUE) { internalDepth = depth--; } else { internalDepth = depth; } + StopWatch.conditionalStart(); if (vertices.size() > 1 && !obj.isContainer()) { + dbTimeMsecs += StopWatch.stopIfStarted(); throw new AAIException("AAI_6136", "query object mismatch: this object cannot hold multiple items." + obj.getDbName()); } else if (obj.isContainer()) { final List getList; @@ -624,6 +636,8 @@ public class DBSerializer { ExecutorService pool = GetAllPool.getInstance().getPool(); List> futures = new ArrayList<>(); + + for (Vertex v : vertices) { Callable task = () -> { Set seen = new HashSet<>(); @@ -640,7 +654,11 @@ public class DBSerializer { for (Future future : futures) { try { getList.add(future.get()); - } catch (ExecutionException | InterruptedException e) { + } catch (ExecutionException e) { + dbTimeMsecs += StopWatch.stopIfStarted(); + throw new AAIException("AAI_4000", e); + } catch (InterruptedException e) { + dbTimeMsecs += StopWatch.stopIfStarted(); throw new AAIException("AAI_4000", e); } } @@ -653,7 +671,7 @@ public class DBSerializer { //obj = null; } - + dbTimeMsecs += StopWatch.stopIfStarted(); return obj; } @@ -747,7 +765,7 @@ public class DBSerializer { Introspector argumentObject = obj.newIntrospectorInstanceOfNestedProperty(property); Object result = dbToObject(argumentObject, childVertex, seen, depth, nodeOnly, cleanUp); - if (result != null) { + if (result != null) { getList.add(argumentObject.getUnderlyingObject()); } @@ -795,13 +813,15 @@ public class DBSerializer { if (nodeType == null) { throw new AAIException("AAI_6143"); } + Introspector obj = this.latestLoader.introspectorFromName(nodeType); Set seen = new HashSet<>(); int depth = 0; String cleanUp = "false"; boolean nodeOnly = true; + StopWatch.conditionalStart(); this.dbToObject(obj, v, seen, depth, nodeOnly, cleanUp); - + dbTimeMsecs += StopWatch.stopIfStarted(); return obj; } @@ -815,10 +835,11 @@ public class DBSerializer { int depth = AAIProperties.MAXIMUM_DEPTH; String cleanUp = "false"; boolean nodeOnly = false; + StopWatch.conditionalStart(); Tree tree = this.engine.getQueryEngine().findSubGraph(v, depth, nodeOnly); TreeBackedVertex treeVertex = new TreeBackedVertex(v, tree); this.dbToObject(obj, treeVertex, seen, depth, nodeOnly, cleanUp); - + dbTimeMsecs += StopWatch.stopIfStarted(); return obj; } /** @@ -959,7 +980,8 @@ public class DBSerializer { uriParser = new URIToRelationshipObject(relationshipObj.getLoader(), uri, this.baseURL); result = uriParser.getResult(); } catch (AAIException | URISyntaxException e) { - LOGGER.error("Error while processing edge relationship in version " + relationshipObj.getVersion() + " (bad vertex ID=" + tuple.get().getValue0().id().toString() + ": " + e.getMessage(), e); + LOGGER.error("Error while processing edge relationship in version " + relationshipObj.getVersion() + " (bad vertex ID=" + tuple.get().getValue0().id().toString() + ": " + + e.getMessage() + " " + LogFormatTools.getStackTop(e)); if ("true".equals(cleanUp)) { this.deleteWithTraversal(tuple.get().getValue0()); } @@ -1003,11 +1025,15 @@ public class DBSerializer { if (aaiUri != null && !overwrite) { uri = UriBuilder.fromPath(aaiUri).build(); } else { + StopWatch.conditionalStart(); Optional>> tuple = this.getParents(this.loader, v, false); + dbTimeMsecs += StopWatch.stopIfStarted(); if (tuple.isPresent()) { List list = tuple.get().getValue1(); uri = this.getURIFromList(list); } + + } return uri; } @@ -1159,7 +1185,7 @@ public class DBSerializer { public boolean createEdge(Introspector relationship, Vertex inputVertex) throws UnsupportedEncodingException, AAIException { Vertex relatedVertex = null; - + StopWatch.conditionalStart(); QueryParser parser = engine.getQueryBuilder().createQueryFromRelationship(relationship); String label = null; @@ -1169,6 +1195,7 @@ public class DBSerializer { List results = parser.getQueryBuilder().toList(); if (results.isEmpty()) { + dbTimeMsecs += StopWatch.stopIfStarted(); AAIException e = new AAIException("AAI_6129", "Node of type " + parser.getResultType() + ". Could not find object at: " + parser.getUri()); e.getTemplateVars().add(parser.getResultType()); e.getTemplateVars().add(parser.getUri().toString()); @@ -1180,14 +1207,20 @@ public class DBSerializer { if (relatedVertex != null) { - Edge e = this.getEdgeBetween(EdgeType.COUSIN, inputVertex, relatedVertex, label); - if (e == null) { - edgeRules.addEdge(this.engine.asAdmin().getTraversalSource(), inputVertex, relatedVertex, label); - } else { - //attempted to link two vertexes already linked + Edge e; + try { + e = this.getEdgeBetween(EdgeType.COUSIN, inputVertex, relatedVertex, label); + if (e == null) { + edgeRules.addEdge(this.engine.asAdmin().getTraversalSource(), inputVertex, relatedVertex, label); + } else { + //attempted to link two vertexes already linked + } + } finally { + dbTimeMsecs += StopWatch.stopIfStarted(); } } + dbTimeMsecs += StopWatch.stopIfStarted(); return true; } @@ -1256,16 +1289,18 @@ public class DBSerializer { */ public Edge getEdgeBetween(EdgeType type, Vertex aVertex, Vertex bVertex, String label) throws AAIException { + StopWatch.conditionalStart(); if (bVertex != null) { List edges = this.getEdgesBetween(type, aVertex, bVertex, label); if (!edges.isEmpty()) { + dbTimeMsecs += StopWatch.stopIfStarted(); return edges.get(0); } } - + dbTimeMsecs += StopWatch.stopIfStarted(); return null; } public Edge getEdgeBetween(EdgeType type, Vertex aVertex, Vertex bVertex) throws AAIException { @@ -1285,7 +1320,7 @@ public class DBSerializer { public boolean deleteEdge(Introspector relationship, Vertex inputVertex) throws UnsupportedEncodingException, AAIException { Vertex relatedVertex = null; - + StopWatch.conditionalStart(); QueryParser parser = engine.getQueryBuilder().createQueryFromRelationship(relationship); List results = parser.getQueryBuilder().toList(); @@ -1296,6 +1331,7 @@ public class DBSerializer { } if (results.isEmpty()) { + dbTimeMsecs += StopWatch.stopIfStarted(); return false; } @@ -1304,12 +1340,15 @@ public class DBSerializer { try { edge = this.getEdgeBetween(EdgeType.COUSIN, inputVertex, relatedVertex, label); } catch (NoEdgeRuleFoundException e) { + dbTimeMsecs += StopWatch.stopIfStarted(); throw new AAIException("AAI_6129", e); } if (edge != null) { edge.remove(); + dbTimeMsecs += StopWatch.stopIfStarted(); return true; } else { + dbTimeMsecs += StopWatch.stopIfStarted(); return false; } @@ -1322,10 +1361,12 @@ public class DBSerializer { * @throws IllegalStateException the illegal state exception */ public void deleteItemsWithTraversal(List vertexes) throws IllegalStateException { + for (Vertex v : vertexes) { - LOGGER.debug("About to delete the vertex with id: " + v.id()); + LOGGER.debug("About to delete the vertex with id: " + v.id()); deleteWithTraversal(v); } + } /** @@ -1334,7 +1375,7 @@ public class DBSerializer { * @param startVertex the start vertex */ public void deleteWithTraversal(Vertex startVertex) { - + StopWatch.conditionalStart(); List results = this.engine.getQueryEngine().findDeletable(startVertex); for (Vertex v : results) { @@ -1342,7 +1383,7 @@ public class DBSerializer { v.remove(); } - + dbTimeMsecs += StopWatch.stopIfStarted(); } /** @@ -1385,8 +1426,10 @@ public class DBSerializer { nodeType = vertex.property(AAIProperties.NODE_TYPE).orElse(null); if (enableResourceVersion && !this.verifyResourceVersion("delete", nodeType, vertex.property(AAIProperties.RESOURCE_VERSION).orElse(null), resourceVersion, nodeType)) { } + StopWatch.conditionalStart(); List preventDeleteVertices = this.engine.asAdmin().getReadOnlyTraversalSource().V(vertex).union(__.inE().has(EdgeProperty.PREVENT_DELETE.toString(), AAIDirection.IN.toString()).outV().values(AAIProperties.NODE_TYPE), __.outE().has(EdgeProperty.PREVENT_DELETE.toString(), AAIDirection.OUT.toString()).inV().values(AAIProperties.NODE_TYPE)).dedup().toList(); + dbTimeMsecs += StopWatch.stopIfStarted(); if (!preventDeleteVertices.isEmpty()) { aaiExceptionCode = "AAI_6110"; errorDetail = String.format("Object is being reference by additional objects preventing it from being deleted. Please clean up references from the following types %s", preventDeleteVertices); @@ -1499,4 +1542,194 @@ public class DBSerializer { runner.execute(obj, self); } + public double getDBTimeMsecs() { + return (dbTimeMsecs); + } + + /** + * Db to object With Filters + * This is for a one-time run with Tenant Isloation to only filter relationships + * TODO: Chnage the original dbToObject to take filter parent/cousins + * + * @param vertices the vertices + * @param obj the obj + * @param depth the depth + * @param cleanUp the clean up + * @return the introspector + * @throws AAIException the AAI exception + * @throws IllegalAccessException the illegal access exception + * @throws IllegalArgumentException the illegal argument exception + * @throws InvocationTargetException the invocation target exception + * @throws SecurityException the security exception + * @throws InstantiationException the instantiation exception + * @throws NoSuchMethodException the no such method exception + * @throws UnsupportedEncodingException the unsupported encoding exception + * @throws MalformedURLException the malformed URL exception + * @throws AAIUnknownObjectException + * @throws URISyntaxException + */ + //TODO - See if you can merge the 2 dbToObjectWithFilters + public Introspector dbToObjectWithFilters(Introspector obj, Vertex v, Set seen, int depth, boolean nodeOnly, List filterCousinNodes, List filterParentNodes) throws AAIException, UnsupportedEncodingException { + String cleanUp = "false"; + if (depth < 0) { + return null; + } + depth--; + seen.add(v); + boolean modified = false; + for (String property : obj.getProperties(PropertyPredicates.isVisible())) { + List getList = null; + Vertex[] vertices = null; + + if (!(obj.isComplexType(property) || obj.isListType(property))) { + this.copySimpleProperty(property, obj, v); + modified = true; + } else { + if (obj.isComplexType(property)) { + /* container case */ + + if (!property.equals("relationship-list") && depth >= 0) { + Introspector argumentObject = obj.newIntrospectorInstanceOfProperty(property); + Object result = dbToObjectWithFilters(argumentObject, v, seen, depth+1, nodeOnly, filterCousinNodes, filterParentNodes); + if (result != null) { + obj.setValue(property, argumentObject.getUnderlyingObject()); + modified = true; + } + } else if (property.equals("relationship-list") && !nodeOnly){ + /* relationships need to be handled correctly */ + Introspector relationshipList = obj.newIntrospectorInstanceOfProperty(property); + relationshipList = createFilteredRelationshipList(v, relationshipList, cleanUp, filterCousinNodes); + if (relationshipList != null) { + modified = true; + obj.setValue(property, relationshipList.getUnderlyingObject()); + modified = true; + } + + } + } else if (obj.isListType(property)) { + + if (property.equals("any")) { + continue; + } + String genericType = obj.getGenericTypeClass(property).getSimpleName(); + if (obj.isComplexGenericType(property) && depth >= 0) { + final String childDbName = convertFromCamelCase(genericType); + String vType = v.property(AAIProperties.NODE_TYPE).orElse(null); + EdgeRule rule; + + boolean isthisParentRequired = filterParentNodes.parallelStream().anyMatch(childDbName::contains); + + + + rule = edgeRules.getEdgeRule(EdgeType.TREE, vType, childDbName); + if (!rule.getContains().equals(AAIDirection.NONE.toString()) && isthisParentRequired) { + //vertices = this.queryEngine.findRelatedVertices(v, Direction.OUT, rule.getLabel(), childDbName); + Direction ruleDirection = rule.getDirection(); + Iterator itr = v.vertices(ruleDirection, rule.getLabel()); + List verticesList = (List)IteratorUtils.toList(itr); + itr = verticesList.stream().filter(item -> { + return item.property(AAIProperties.NODE_TYPE).orElse("").equals(childDbName); + }).iterator(); + if (itr.hasNext()) { + getList = (List)obj.getValue(property); + } + int processed = 0; + int removed = 0; + while (itr.hasNext()) { + Vertex childVertex = itr.next(); + if (!seen.contains(childVertex)) { + Introspector argumentObject = obj.newIntrospectorInstanceOfNestedProperty(property); + + Object result = dbToObjectWithFilters(argumentObject, childVertex, seen, depth, nodeOnly, filterCousinNodes, filterParentNodes); + if (result != null) { + getList.add(argumentObject.getUnderlyingObject()); + } + + processed++; + } else { + removed++; + LOGGER.warn("Cycle found while serializing vertex id={}", childVertex.id().toString()); + } + } + if (processed == 0) { + //vertices were all seen, reset the list + getList = null; + } + if (processed > 0) { + modified = true; + } + } + } else if (obj.isSimpleGenericType(property)) { + List temp = this.engine.getListProperty(v, property); + if (temp != null) { + getList = (List)obj.getValue(property); + getList.addAll(temp); + modified = true; + } + + } + + } + + } + } + + //no changes were made to this obj, discard the instance + if (!modified) { + return null; + } + this.enrichData(obj, v); + return obj; + + } + + /** + * Creates the relationship list with the filtered node types. + * + * @param v the v + * @param obj the obj + * @param cleanUp the clean up + * @return the object + * @throws InstantiationException the instantiation exception + * @throws IllegalAccessException the illegal access exception + * @throws IllegalArgumentException the illegal argument exception + * @throws InvocationTargetException the invocation target exception + * @throws NoSuchMethodException the no such method exception + * @throws SecurityException the security exception + * @throws UnsupportedEncodingException the unsupported encoding exception + * @throws AAIException the AAI exception + * @throws MalformedURLException the malformed URL exception + * @throws URISyntaxException + */ + private Introspector createFilteredRelationshipList(Vertex v, Introspector obj, String cleanUp, List filterNodes) throws UnsupportedEncodingException, AAIException { + List allCousins = this.engine.getQueryEngine().findCousinVertices(v); + + Iterator cousinVertices = allCousins.stream().filter(item -> { + String node = (String)item.property(AAIProperties.NODE_TYPE).orElse(""); + return filterNodes.parallelStream().anyMatch(node::contains); + }).iterator(); + + + List cousins = (List)IteratorUtils.toList(cousinVertices); + + //items.parallelStream().anyMatch(inputStr::contains) + List relationshipObjList = obj.getValue("relationship"); + for (Vertex cousin : cousins) { + + Introspector relationshipObj = obj.newIntrospectorInstanceOfNestedProperty("relationship"); + Object result = processEdgeRelationship(relationshipObj, cousin, cleanUp, null); + if (result != null) { + relationshipObjList.add(result); + } + + + } + + if (relationshipObjList.isEmpty()) { + return null; + } else { + return obj; + } + } + } diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeProperty.java b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeProperty.java index ecd749c7..65753a26 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeProperty.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeProperty.java @@ -1,21 +1,23 @@ -/*- +/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright Ā© 2017 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 - * + * + * 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.serialization.db; @@ -24,7 +26,8 @@ public enum EdgeProperty { CONTAINS("contains-other-v"), DELETE_OTHER_V("delete-other-v"), SVC_INFRA("SVC-INFRA"), - PREVENT_DELETE("prevent-delete"); + PREVENT_DELETE("prevent-delete"), + DESCRIPTION("description"); private final String name; private EdgeProperty(String name) { diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRule.java b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRule.java index ae9e96c0..0a32db7c 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRule.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRule.java @@ -1,30 +1,31 @@ -/*- +/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright Ā© 2017 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 - * + * + * 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.serialization.db; +import org.apache.tinkerpop.gremlin.structure.Direction; + import java.util.EnumMap; import java.util.Map; -import org.apache.tinkerpop.gremlin.structure.Direction; - public class EdgeRule { private String label = ""; @@ -32,14 +33,32 @@ public class EdgeRule { private Direction direction = null; private Map edgeProperties = null; private boolean isDefaultEdge = false; - + private String from; + private String to; + /** * Instantiates a new edge rule. */ public EdgeRule() { edgeProperties = new EnumMap<>(EdgeProperty.class); } - + + public String getFrom() { + return from; + } + + public void setFrom(String from) { + this.from = from; + } + + public String getTo() { + return to; + } + + public void setTo(String to) { + this.to = to; + } + /** * Gets the label. * @@ -210,14 +229,14 @@ public class EdgeRule { public boolean isDefault() { return isDefaultEdge; } - + public void setIsDefault(boolean isDefault) { this.isDefaultEdge = isDefault; } - + public void setIsDefault(String isDefault) { this.isDefaultEdge = "true".equals(isDefault); } - - + + } diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRules.java b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRules.java index 349f9e6b..622c3067 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRules.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/EdgeRules.java @@ -25,14 +25,8 @@ import static com.jayway.jsonpath.Criteria.where; import static com.jayway.jsonpath.Filter.filter; import java.io.InputStream; -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; +import java.util.*; import java.util.Map.Entry; -import java.util.Optional; -import java.util.Scanner; -import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; @@ -243,6 +237,8 @@ public class EdgeRules { for (Entry entry : propMap.entrySet()) { edge.property(entry.getKey().toString(), entry.getValue()); } + + edge.property(AAIProperties.AAI_UUID, UUID.randomUUID().toString()); } /** @@ -652,11 +648,17 @@ public class EdgeRules { rule.setDeleteOtherV(edge.get(EdgeProperty.DELETE_OTHER_V.toString())); rule.setServiceInfrastructure(edge.get(EdgeProperty.SVC_INFRA.toString())); rule.setPreventDelete(edge.get(EdgeProperty.PREVENT_DELETE.toString())); + rule.setTo(edge.get("to")); + rule.setFrom(edge.get("from")); if (edge.containsKey("default")) { rule.setIsDefault(edge.get("default")); } - return rule; + if(rule.getFrom().equals(rule.getTo())){ + return this.flipDirection(rule); + } else { + return rule; + } } /** @@ -777,6 +779,11 @@ public class EdgeRules { */ private void verifyRule(Map rule) { for (EdgeProperty prop : EdgeProperty.values()) { + + // Description is not required as it is only set for v12 versions + if("description".equals(prop.toString())){ + continue; + } if (!rule.containsKey(prop.toString())) { /* Throws RuntimeException as rule definition errors * cannot be recovered from, and should never happen anyway diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/InMemoryGraphSingleton.java b/aai-core/src/main/java/org/onap/aai/serialization/db/InMemoryGraphSingleton.java new file mode 100644 index 00000000..091ab457 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/InMemoryGraphSingleton.java @@ -0,0 +1,60 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.serialization.db; + +import org.onap.aai.dbmap.DBConnectionType; + +import com.thinkaurelius.titan.core.TitanGraph; + +public class InMemoryGraphSingleton extends GraphSingleton { + + private static TitanGraph inMemgraph; + + private static class Helper { + private static final InMemoryGraphSingleton INSTANCE = new InMemoryGraphSingleton(); + } + + /** + * Gets the single instance of TitanGraphSingleton. + * + * @return single instance of TitanGraphSingleton + */ + public static InMemoryGraphSingleton getInstance(TitanGraph graph) { + inMemgraph = graph; + return Helper.INSTANCE; + } + + /** + * Gets the tx graph. + * + * @return the tx graph + */ + @Override + public TitanGraph getTxGraph() { + return inMemgraph; + } + + @Override + public TitanGraph getTxGraph(DBConnectionType connectionType) { + return inMemgraph; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/serialization/db/exceptions/MultipleEdgeRuleFoundException.java b/aai-core/src/main/java/org/onap/aai/serialization/db/exceptions/MultipleEdgeRuleFoundException.java index bb4ba4df..f94eb407 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/db/exceptions/MultipleEdgeRuleFoundException.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/db/exceptions/MultipleEdgeRuleFoundException.java @@ -1,21 +1,23 @@ -/*- +/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright Ā© 2017 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 - * + * + * 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.serialization.db.exceptions; @@ -25,7 +27,7 @@ import org.onap.aai.exceptions.AAIException; public class MultipleEdgeRuleFoundException extends AAIException { private static final long serialVersionUID = -906843868234976763L; - + public MultipleEdgeRuleFoundException(String message) { super("AAI_6107", message); } diff --git a/aai-core/src/main/java/org/onap/aai/serialization/engines/InMemoryDBEngine.java b/aai-core/src/main/java/org/onap/aai/serialization/engines/InMemoryDBEngine.java new file mode 100644 index 00000000..197aff94 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/serialization/engines/InMemoryDBEngine.java @@ -0,0 +1,207 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.serialization.engines; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; +import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReadOnlyStrategy; +import org.apache.tinkerpop.gremlin.structure.Graph; +import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.apache.tinkerpop.gremlin.structure.VertexProperty; + +import org.onap.aai.dbmap.DBConnectionType; +import org.onap.aai.introspection.Loader; +import org.onap.aai.query.builder.GremlinTraversal; +import org.onap.aai.query.builder.GremlinUnique; +import org.onap.aai.query.builder.QueryBuilder; +import org.onap.aai.query.builder.TraversalQuery; +import org.onap.aai.serialization.db.InMemoryGraphSingleton; +import org.onap.aai.serialization.engines.query.GraphTraversalQueryEngine; +import org.onap.aai.serialization.engines.query.QueryEngine; +import org.onap.aai.serialization.engines.TransactionalGraphEngine; + +import com.thinkaurelius.titan.core.TitanGraph; + +public class InMemoryDBEngine extends TransactionalGraphEngine { + + /** + * Instantiates a new titan DB engine. + * + * @param style + * the style + * @param loader + * the loader + */ + private TitanGraph graph = null; + + private static final TransactionalGraphEngine.Admin admin = null; + + public InMemoryDBEngine(QueryStyle style, DBConnectionType connectionType, Loader loader, TitanGraph graph) { + super(style, loader, connectionType, InMemoryGraphSingleton.getInstance(graph)); + this.graph = graph; + } + + /** + * Instantiates a new titan DB engine. + * + * @param style + * the style + * @param loader + * the loader + * @param connect + * the connect + */ + public InMemoryDBEngine(QueryStyle style, Loader loader, boolean connect, TitanGraph graph) { + super(style, loader); + if (connect) { + this.singleton = InMemoryGraphSingleton.getInstance(graph); + } + this.graph = graph; + } + + @Override + public QueryEngine getQueryEngine() { + + if (style.equals(QueryStyle.TRAVERSAL)) { + + GraphTraversalSource traversalSource = graph.traversal(); + return new GraphTraversalQueryEngine(traversalSource); + + } else { + throw new IllegalArgumentException("Query Engine type not recognized"); + } + + } + + @Override + public QueryBuilder getQueryBuilder(QueryStyle style, Loader loader) { + if (style.equals(QueryStyle.GREMLIN_TRAVERSAL)) { + return new GremlinTraversal<>(loader, graph.traversal()); + } else if (style.equals(QueryStyle.TRAVERSAL)) { + return new TraversalQuery<>(loader, graph.traversal()); + + } else { + throw new IllegalArgumentException("Query Builder type is Not recognized"); + } + + } + + /** + * {@inheritDoc} + */ + @Override + public boolean setListProperty(Vertex v, String name, List objs) { + + // clear out list full replace style + + Iterator> iterator = v.properties(name); + while (iterator.hasNext()) { + iterator.next().remove(); + } + if (objs != null) { + for (Object obj : objs) { + v.property(name, obj); + } + } + return true; + } + + /** + * {@inheritDoc} + */ + @Override + public List getListProperty(Vertex v, String name) { + + List result = new ArrayList<>(); + + Iterator> iterator = v.properties(name); + + while (iterator.hasNext()) { + result.add(iterator.next().value()); + } + + if (result.isEmpty()) { + result = null; + } + + return result; + + } + + @Override + public QueryBuilder getQueryBuilder() { + return getQueryBuilder(this.loader); + } + + @Override + public QueryBuilder getQueryBuilder(Loader loader) { + if (style.equals(QueryStyle.GREMLIN_TRAVERSAL)) { + return new GremlinTraversal<>(loader, this.asAdmin().getTraversalSource()); + } else if (style.equals(QueryStyle.GREMLIN_UNIQUE)) { + return new GremlinUnique<>(loader, this.asAdmin().getTraversalSource()); + } else if (style.equals(QueryStyle.TRAVERSAL)) { + return new TraversalQuery<>(loader, graph.traversal()); + } else { + throw new IllegalArgumentException("Query Builder type not recognized"); + } + + } + + @Override + public QueryBuilder getQueryBuilder(Vertex start) { + return getQueryBuilder(this.loader, start); + } + + public GraphTraversalSource getTraversalSource() { + return graph.traversal(); + } + + @Override + public QueryBuilder getQueryBuilder(Loader loader, Vertex start) { + if (style.equals(QueryStyle.GREMLIN_TRAVERSAL)) { + return new GremlinTraversal<>(loader, graph.traversal(), start); + } else if (style.equals(QueryStyle.GREMLIN_UNIQUE)) { + return new GremlinUnique<>(loader, this.asAdmin().getTraversalSource(), start); + } else if (style.equals(QueryStyle.TRAVERSAL)) { + return new TraversalQuery<>(loader, graph.traversal(), start); + } else { + throw new IllegalArgumentException("Query Builder type not recognized"); + } + + } + + @Override + public Graph startTransaction() { + if (this.tx() == null) { + this.currentTx = graph.newTransaction(); + this.currentTraversal = this.tx().traversal(); + this.readOnlyTraversal = this.tx() + .traversal(GraphTraversalSource.build().with(ReadOnlyStrategy.instance())); + } + return currentTx; + } + + + +} diff --git a/aai-core/src/main/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngine.java b/aai-core/src/main/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngine.java index 7efe2ea9..27733039 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngine.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngine.java @@ -42,6 +42,7 @@ import org.apache.tinkerpop.gremlin.structure.Element; import org.apache.tinkerpop.gremlin.structure.Vertex; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.introspection.Loader; +import org.onap.aai.logging.StopWatch; /* * This class needs some big explanation despite its compact size. @@ -68,10 +69,15 @@ public class GraphTraversalQueryEngine extends QueryEngine { */ @Override public List findParents(Vertex start) { - - @SuppressWarnings("unchecked") - final GraphTraversal pipe = this.g.V(start).emit(v -> true).repeat(__.union(__.inE().has(CONTAINS.toString(), OUT.toString()).outV(), __.outE().has(CONTAINS.toString(), IN.toString()).inV())); - return pipe.toList(); + try { + StopWatch.conditionalStart(); + @SuppressWarnings("unchecked") + final GraphTraversal pipe = this.g.V(start).emit(v -> true).repeat(__.union(__.inE().has(CONTAINS.toString(), OUT.toString()).outV(), __.outE().has(CONTAINS.toString(), IN.toString()).inV())); + return pipe.toList(); + } + finally { + dbTimeMsecs += StopWatch.stopIfStarted(); + } } /** @@ -129,7 +135,7 @@ public class GraphTraversalQueryEngine extends QueryEngine { __.outE().has(DELETE_OTHER_V.toString(), OUT.toString()).inV(), __.inE().has(DELETE_OTHER_V.toString(), IN.toString()).outV() ) - ); + ).dedup(); return pipe.toList(); } @@ -201,5 +207,8 @@ public class GraphTraversalQueryEngine extends QueryEngine { return pipeline.toList(); } + public double getDBTimeMsecs() { + return (dbTimeMsecs); + } } diff --git a/aai-core/src/main/java/org/onap/aai/serialization/engines/query/QueryEngine.java b/aai-core/src/main/java/org/onap/aai/serialization/engines/query/QueryEngine.java index 5a468b79..0e000948 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/engines/query/QueryEngine.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/engines/query/QueryEngine.java @@ -34,8 +34,8 @@ import java.util.List; public abstract class QueryEngine { - protected final GraphTraversalSource g; - + final protected GraphTraversalSource g; + protected double dbTimeMsecs = 0; /** * Instantiates a new query engine. * @@ -145,4 +145,6 @@ public abstract class QueryEngine { */ public abstract List findCousinVertices(Vertex start); + public abstract double getDBTimeMsecs(); + } diff --git a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatFactory.java b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatFactory.java index 21a7e0fe..aec0be27 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatFactory.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatFactory.java @@ -31,9 +31,6 @@ import org.onap.aai.serialization.queryformats.exceptions.QueryParamInjectionExc import org.onap.aai.serialization.queryformats.utils.QueryParamInjector; import org.onap.aai.serialization.queryformats.utils.UrlBuilder; -import javax.ws.rs.core.MultivaluedHashMap; -import javax.ws.rs.core.MultivaluedMap; - public class FormatFactory { private final Loader loader; diff --git a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatMapper.java b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatMapper.java index 27d204a6..44018354 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatMapper.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/FormatMapper.java @@ -21,9 +21,9 @@ */ package org.onap.aai.serialization.queryformats; +import com.google.gson.JsonObject; import org.onap.aai.serialization.queryformats.exceptions.AAIFormatQueryResultFormatNotSupported; import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException; -import com.google.gson.JsonObject; public interface FormatMapper { diff --git a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/Formatter.java b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/Formatter.java index b145d423..698aef6e 100644 --- a/aai-core/src/main/java/org/onap/aai/serialization/queryformats/Formatter.java +++ b/aai-core/src/main/java/org/onap/aai/serialization/queryformats/Formatter.java @@ -21,19 +21,20 @@ */ package org.onap.aai.serialization.queryformats; -import java.util.List; -import java.util.Optional; -import java.util.stream.Stream; - -import org.onap.aai.serialization.queryformats.exceptions.AAIFormatQueryResultFormatNotSupported; -import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException; - import com.att.eelf.configuration.EELFLogger; import com.att.eelf.configuration.EELFManager; import com.google.gson.JsonArray; import com.google.gson.JsonObject; import com.google.gson.JsonParser; +import org.onap.aai.logging.LogFormatTools; +import org.onap.aai.serialization.queryformats.exceptions.AAIFormatQueryResultFormatNotSupported; +import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException; + +import java.util.List; +import java.util.Optional; +import java.util.stream.Stream; + public class Formatter { private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(Formatter.class); @@ -50,14 +51,14 @@ public class Formatter { Stream stream = null; JsonObject result = new JsonObject(); JsonArray body = new JsonArray(); - + if (this.format instanceof Count) { JsonObject countResult; try { countResult = format.formatObject(queryResults); - body.add(countResult); + body.add(countResult); } catch (Exception e) { - LOGGER.warn("Failed to format result type of the query", e); + LOGGER.warn("Failed to format result type of the query " + LogFormatTools.getStackTop(e)); } } else { if (queryResults.size() >= format.parallelThreshold()) { @@ -65,16 +66,16 @@ public class Formatter { } else { stream = queryResults.stream(); } - + final boolean isParallel = stream.isParallel(); - + stream.map(o -> { try { return Optional.of(format.formatObject(o)); } catch (AAIFormatVertexException e) { - LOGGER.warn("Failed to format vertex, returning a partial list", e); + LOGGER.warn("Failed to format vertex, returning a partial list " + LogFormatTools.getStackTop(e)); } catch (AAIFormatQueryResultFormatNotSupported e) { - LOGGER.warn("Failed to format result type of the query", e); + LOGGER.warn("Failed to format result type of the query " + LogFormatTools.getStackTop(e)); } return Optional.empty(); diff --git a/aai-core/src/main/java/org/onap/aai/tasks/ScheduledTasks.java b/aai-core/src/main/java/org/onap/aai/tasks/ScheduledTasks.java index 9d2e8b68..e1f554ad 100644 --- a/aai-core/src/main/java/org/onap/aai/tasks/ScheduledTasks.java +++ b/aai-core/src/main/java/org/onap/aai/tasks/ScheduledTasks.java @@ -32,6 +32,7 @@ import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; import org.onap.aai.util.AAIConfig; import org.onap.aai.util.AAIConstants; import com.att.eelf.configuration.EELFLogger; @@ -57,9 +58,15 @@ public class ScheduledTasks { public void loadAAIProperties() { final UUID transId = UUID.randomUUID(); + LoggingContext.init(); LoggingContext.requestId(transId); LoggingContext.partnerName(FROM_APP_ID); LoggingContext.component(COMPONENT); + LoggingContext.targetEntity("AAI"); + LoggingContext.targetServiceName("loadAAIProperties"); + LoggingContext.serviceName("AAI"); + LoggingContext.statusCode(StatusCode.COMPLETE); + LoggingContext.responseCode(LoggingContext.SUCCESS); String dir = FilenameUtils.getFullPathNoEndSeparator(GlobalPropFileName); if (dir == null || dir.length() < 3) { @@ -82,7 +89,7 @@ public class ScheduledTasks { long curTSTm = curTS.getTime(); if (curTSTm - lastModTm < PROPERTY_READ_INTERVAL + 1000) { AAIConfig.reloadConfig(); - LOGGER.info("reloaded from aaiconfig.properties"); + LOGGER.debug("reloaded from aaiconfig.properties"); } break; } diff --git a/aai-core/src/main/java/org/onap/aai/util/AAIApiServerURLBase.java b/aai-core/src/main/java/org/onap/aai/util/AAIApiServerURLBase.java index 45f671ef..e458c4f9 100644 --- a/aai-core/src/main/java/org/onap/aai/util/AAIApiServerURLBase.java +++ b/aai-core/src/main/java/org/onap/aai/util/AAIApiServerURLBase.java @@ -73,8 +73,7 @@ public class AAIApiServerURLBase { */ public static String get(Version v) throws AAIException { String hostName = null; - hostName = AAIApiServerURLBase.get(); - + hostName = AAIApiServerURLBase.get(); return hostName; } diff --git a/aai-core/src/main/java/org/onap/aai/util/AAIConfig.java b/aai-core/src/main/java/org/onap/aai/util/AAIConfig.java index 445fa0dd..57bf2cc7 100644 --- a/aai-core/src/main/java/org/onap/aai/util/AAIConfig.java +++ b/aai-core/src/main/java/org/onap/aai/util/AAIConfig.java @@ -30,6 +30,10 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.Properties; import java.util.Timer; +import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; + +import java.util.UUID; import org.eclipse.jetty.util.security.Password; @@ -62,6 +66,16 @@ public class AAIConfig { * @throws AAIException the AAI exception */ public synchronized static void init() throws AAIException{ + + LoggingContext.save(); + LoggingContext.component("config"); + LoggingContext.partnerName("NA"); + LoggingContext.targetEntity("AAI"); + LoggingContext.requestId(UUID.randomUUID().toString()); + LoggingContext.serviceName("AAI"); + LoggingContext.targetServiceName("init"); + LoggingContext.statusCode(StatusCode.COMPLETE); + LOGGER.info("Initializing AAIConfig"); ArrayList genericVnfBools = new ArrayList(); @@ -96,6 +110,7 @@ public class AAIConfig { } else { LOGGER.info("A&AI Server Node Name = " + AAIConstants.AAI_NODENAME); } + LoggingContext.restore(); } /** @@ -137,7 +152,7 @@ public class AAIConfig { String propFileName = GLOBAL_PROP_FILE_NAME; Properties newServerProps = null; - LOGGER.info("Reloading config from " + propFileName); + LOGGER.debug("Reloading config from " + propFileName); try { InputStream is = new FileInputStream(propFileName); diff --git a/aai-core/src/main/java/org/onap/aai/util/AAIConstants.java b/aai-core/src/main/java/org/onap/aai/util/AAIConstants.java index e201b6d8..9c875ec8 100644 --- a/aai-core/src/main/java/org/onap/aai/util/AAIConstants.java +++ b/aai-core/src/main/java/org/onap/aai/util/AAIConstants.java @@ -47,6 +47,8 @@ public final class AAIConstants { public static final String CACHED_DB_CONFIG = AAI_HOME_ETC_APP_PROPERTIES + "titan-cached.properties"; public static final String AAI_HOME_ETC_OXM = AAI_HOME_ETC + "oxm" + AAI_FILESEP; public static final String AAI_EVENT_DMAAP_PROPS = AAI_HOME_ETC_APP_PROPERTIES + "aaiEventDMaaPPublisher.properties"; + public static final String AAI_HOME_ETC_SCRIPT = AAI_HOME_ETC + AAI_FILESEP + "scriptdata" + AAI_FILESEP; + public static final String AAI_PROV_LOGBACK_PROPS = "prov-logback.xml"; public static final String AAI_GETRES_LOGBACK_PROPS = "getres-logback.xml"; @@ -96,6 +98,14 @@ public final class AAIConstants { public static final String AAI_BULKCONSUMER_LIMIT = "aai.bulkconsumer.payloadlimit"; public static final String AAI_BULKCONSUMER_OVERRIDE_LIMIT = "aai.bulkconsumer.payloadoverride"; + public static final String AAI_TRAVERSAL_TIMEOUT_LIMIT = "aai.traversal.timeoutlimit"; + public static final String AAI_TRAVERSAL_TIMEOUT_ENABLED = "aai.traversal.timeoutenabled"; + public static final String AAI_TRAVERSAL_TIMEOUT_APP = "aai.traversal.timeout.appspecific"; + + public static final String AAI_CRUD_TIMEOUT_LIMIT = "aai.crud.timeoutlimit"; + public static final String AAI_CRUD_TIMEOUT_ENABLED = "aai.crud.timeoutenabled"; + public static final String AAI_CRUD_TIMEOUT_APP = "aai.crud.timeout.appspecific"; + public static final String AAI_LOGGING_HBASE_INTERCEPTOR = "aai.logging.hbase.interceptor"; public static final String AAI_LOGGING_HBASE_ENABLED = "aai.logging.hbase.enabled"; public static final String AAI_LOGGING_HBASE_LOGREQUEST = "aai.logging.hbase.logrequest"; @@ -124,7 +134,7 @@ public final class AAIConstants { public static final String AAI_SKIPREALTIME_GROOMING = (System.getProperty("aai.skiprealtime.grooming") == null) ? "true" : System.getProperty("aai.skiprealtime.grooming"); - /*** UEB ***/ + /*** UEB ***/ public static final String UEB_PUB_PARTITION_AAI = "AAI"; public static final String UEB_PUB_AAI_VCE_INTERFACE_DATA_TOPIC = "ueb.pub.aai.vce.interface.data.topic"; diff --git a/aai-core/src/main/java/org/onap/aai/util/AAIRSyncUtility.java b/aai-core/src/main/java/org/onap/aai/util/AAIRSyncUtility.java index f20346eb..448d067a 100644 --- a/aai-core/src/main/java/org/onap/aai/util/AAIRSyncUtility.java +++ b/aai-core/src/main/java/org/onap/aai/util/AAIRSyncUtility.java @@ -35,7 +35,7 @@ import java.util.StringTokenizer; import org.onap.aai.exceptions.AAIException; import com.att.eelf.configuration.EELFLogger; import com.att.eelf.configuration.EELFManager; - +import org.onap.aai.logging.ErrorLogHelper; public class AAIRSyncUtility { @@ -145,7 +145,7 @@ public class AAIRSyncUtility { } } } catch ( Exception e) { - LOGGER.error("no server found processing serverList for host " + host + ": " + e.getMessage() + " (AAI_4000)"); + ErrorLogHelper.logError("AAI_4000", "no server found processing serverList for host " + host + ": " + e.getMessage()); } } diff --git a/aai-core/src/main/java/org/onap/aai/util/AAISystemExitUtil.java b/aai-core/src/main/java/org/onap/aai/util/AAISystemExitUtil.java new file mode 100644 index 00000000..9149d0b4 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/AAISystemExitUtil.java @@ -0,0 +1,34 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import org.onap.aai.dbmap.AAIGraph; + +public class AAISystemExitUtil { + + public static void systemExitCloseAAIGraph(int code) { + if (AAIGraph.isInit()) { + AAIGraph.getInstance().graphShutdown(); + } + System.exit(code); + } +} diff --git a/aai-core/src/main/java/org/onap/aai/util/AutoGenerateHtml.java b/aai-core/src/main/java/org/onap/aai/util/AutoGenerateHtml.java new file mode 100644 index 00000000..f0489da2 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/AutoGenerateHtml.java @@ -0,0 +1,67 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import java.io.File; +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.ListIterator; + +import org.onap.aai.introspection.Version; +import org.onap.aai.util.swagger.GenerateSwagger; + +import freemarker.template.TemplateException; + +public class AutoGenerateHtml { + + public static final String DEFAULT_SCHEMA_DIR = "../aai-schema"; + //if the program is run from aai-common, use this directory as default" + public static final String ALT_SCHEMA_DIR = "aai-schema"; + //used to check to see if program is run from aai-core + public static final String DEFAULT_RUN_DIR = "aai-core"; + + public static void main(String[] args) throws IOException, TemplateException { + String savedProperty = System.getProperty("aai.generate.version"); + List versionsToGen = Arrays.asList(Version.values()); + Collections.sort(versionsToGen); + Collections.reverse(versionsToGen); + ListIterator versionIterator = versionsToGen.listIterator(); + String schemaDir; + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(DEFAULT_RUN_DIR)) { + schemaDir = ALT_SCHEMA_DIR; + } + else { + schemaDir = DEFAULT_SCHEMA_DIR; + } + while (versionIterator.hasNext()) { + System.setProperty("aai.generate.version", versionIterator.next().toString()); + String yamlFile = schemaDir + "/src/main/resources/aai_swagger_yaml/aai_swagger_" + System.getProperty("aai.generate.version")+ ".yaml"; + File swaggerYamlFile = new File(yamlFile); + if(swaggerYamlFile.exists()) { + GenerateSwagger.main(args); + } + } + String versionToGenerate = System.setProperty("aai.generate.version", savedProperty); + } +} 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 d2dc8b76..af9171dd 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,9 +7,9 @@ * 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. @@ -19,13 +19,18 @@ * * 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; + import org.onap.aai.introspection.Version; import org.onap.aai.serialization.db.EdgeProperty; import org.w3c.dom.*; +import org.xml.sax.InputSource; import javax.xml.XMLConstants; import javax.xml.parsers.DocumentBuilder; @@ -38,10 +43,13 @@ 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; static String apiVersionFmt = null; static boolean useAnnotationsInXsd = false; @@ -51,9 +59,24 @@ public class GenerateXsd { 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; @@ -64,12 +87,17 @@ public class GenerateXsd { private static final String root = "../aai-schema/src/main/resources"; private static final String xsd_dir = root + "/aai_schema"; private static final String yaml_dir = 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 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; @@ -77,10 +105,91 @@ public class GenerateXsd { 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; @@ -91,6 +200,9 @@ public class GenerateXsd { public String getDirection() { return direction; } + public String getDescription() { + return this.description; + } public void setRuleKey(String val) { this.ruleKey=val; } @@ -106,6 +218,9 @@ public class GenerateXsd { public void setHasDelTarget(String val) { hasDelTarget = Boolean.parseBoolean(val); } + public void setDescription(String val) { + this.description = val; + } public String getRelationshipDescription(String fromTo, String otherNodeName) { @@ -114,95 +229,487 @@ public class GenerateXsd { if ("FROM".equals(fromTo)) { if ("OUT".equals(direction)) { if (LineageType.PARENT == type) { - result = " (is composed of "+otherNodeName; + result = " (PARENT of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getLabel(), this.to); } } else { if (LineageType.CHILD == type) { - result = " (comprises "+otherNodeName; + result = " (CHILD of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getLabel(), this.to); } else if (LineageType.PARENT == type) { - result = " (comprises "+otherNodeName; + 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 = " (comprises "+otherNodeName; + result = " (CHILD of "+otherNodeName; + result = String.join(" ", result+",", this.from, this.getLabel(), this.to+",", this.getMultiplicity()); } } else { if (LineageType.PARENT == type) { - result = " (is composed of "+otherNodeName; + 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 (type != null) { -// if (LineageType.PARENT.equals(type) && "FROM".equals(fromTo)) { -// if ("OUT".equals(direction)) { -// result = " (is composed of "+otherNodeName; -// } else { -// result = " (comprises "+otherNodeName; -// } -// } else { -// result = " (comprises " + otherNodeName; -// // if (!(multiplicity.startsWith("One"))) { -// // System.err.println("Surprised to find multiplicity "+multiplicity+" with comprises for "+ruleKey); -// // } -// } -// } - if ("TO".equals(fromTo)) { - if (result.length() == 0) result = result + " ("; - else result = result + ", "; - - result = result + mapMultiplicity(fromTo); - if (hasDelTarget) result = result + ", will delete target node"; } + 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; } - private String mapMultiplicity(String fromTo) { - String result = multiplicity; -// Below logic works if an IN switches multiplicity, which it doesn't today. -// if ("TO".equals(fromTo)) { -// if (direction.equals("OUT")) { -// result = multiplicity; -// } else { -// result = switchMultiplicity(multiplicity); -// } -// } else { -// if (direction.equals("OUT")) { -// result = multiplicity; -// } else { -// result = switchMultiplicity(multiplicity); -// } -// } - 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(); -// private String switchMultiplicity(String val) throws IllegalArgumentException -// { -// String result = null; -// switch (val) { -// case "Many2Many": -// case "One2One": -// result = val; -// break; -// case "Many2One": -// result = "One2Many"; -// break; -// case "One2Many": -// result = "Many2One"; -// break; -// default: -// throw new IllegalArgumentException("Multiplicity cannot be "+val); -// } -// System.out.println("Switched Multiplicity from "+val+" to "+result); -// return result; -// } + } + 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) { @@ -247,57 +754,75 @@ public class GenerateXsd { } + String responsesLabel = System.getProperty("yamlresponses_url"); + responsesUrl = responsesLabel; + + List versionsToGen = new ArrayList<>(); if ( versionToGen == null ) { System.err.println("Version is required, ie v or ALL."); System.exit(1); } - - responsesUrl = System.getProperty("yamlresponses_url"); - String responsesLabel = System.getProperty("yamlresponses_label"); - List versionsToGen = new ArrayList<>(); - - - if (!"ALL".equalsIgnoreCase(versionToGen) && !versionToGen.matches("v\\d+") && !validVersion(versionToGen)) { + else if (!"ALL".equalsIgnoreCase(versionToGen) && !versionToGen.matches("v\\d+") && !validVersion(versionToGen)) { System.err.println("Invalid version passed. " + versionToGen); System.exit(1); } - - if ("ALL".equalsIgnoreCase(versionToGen)) { + else if ("ALL".equalsIgnoreCase(versionToGen)) { versionsToGen = Arrays.asList(Version.values()); Collections.sort(versionsToGen); Collections.reverse(versionsToGen); } else { versionsToGen.add(Version.valueOf(versionToGen)); } - - if ( fileTypeToGen.equals(generateTypeYAML) ) { + + //process file type System property + fileTypeToGen = (fileTypeToGen == null ? generateTypeXSD : fileTypeToGen.toLowerCase()); + if ( !fileTypeToGen.equals( generateTypeXSD ) && !fileTypeToGen.equals( generateTypeYAML )) { + System.err.println("Invalid gen_type passed. " + fileTypeToGen); + System.exit(1); + } else if ( fileTypeToGen.equals(generateTypeYAML) ) { if ( responsesUrl == null || responsesUrl.length() < 1 || responsesLabel == null || responsesLabel.length() < 1 ) { System.err.println("generating swagger yaml file requires yamlresponses_url and yamlresponses_label properties" ); System.exit(1); + } else { + responsesUrl = "description: "+ "Response codes found in [response codes]("+responsesLabel+ ").\n"; } - responsesUrl = "description: "+ responsesLabel+ "(" + responsesUrl + ").\n"; } - String oxmPath = root + "/oxm/"; - + String oxmPath; + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(normalStartDir)) { + oxmPath = autoGenRoot + "/oxm/"; + } + else { + oxmPath = root + "/oxm/"; + } + String outfileName; File outfile; String fileContent; for (Version v : versionsToGen) { apiVersion = v.toString(); - System.out.println("Generating " + apiVersion + " " + fileTypeToGen); + logger.info("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(); + if ( fileTypeToGen.equals(generateTypeXSD) ) { useAnnotationsInXsd = versionUsesAnnotations(apiVersion); outfileName = xsd_dir + "/aai_schema_" + apiVersion + "." + generateTypeXSD; - fileContent = processOxmFile(oxm_file, v); + fileContent = processOxmFile(oxm_file, v, null); } else if ( versionSupportsSwagger(apiVersion )) { - outfileName = yaml_dir + "/aai_swagger_" + apiVersion + "." + generateTypeYAML; - fileContent = generateSwaggerFromOxmFile( oxm_file); + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(normalStartDir)) { + outfileName = alt_yaml_dir; + } + else { + outfileName = yaml_dir; + } + outfileName = outfileName + "/aai_swagger_" + apiVersion + "." + generateTypeYAML; + fileContent = generateSwaggerFromOxmFile( oxm_file, null); } else { continue; } @@ -309,7 +834,7 @@ public class GenerateXsd { try { outfile.createNewFile(); } catch (IOException e) { - System.out.println( "Exception creating output file " + outfileName); + logger.error( "Exception creating output file " + outfileName); e.printStackTrace(); } BufferedWriter bw = null; @@ -319,14 +844,14 @@ public class GenerateXsd { bw = Files.newBufferedWriter(path, charset); bw.write(fileContent); } catch ( IOException e) { - System.out.println( "Exception writing output file " + outfileName); + logger.error( "Exception writing output file " + outfileName); e.printStackTrace(); } finally { if ( bw != null ) { bw.close(); } } - System.out.println( "GeneratedXSD successful, saved in " + outfileName); + logger.info( "GeneratedXSD successful, saved in " + outfileName); } } @@ -339,7 +864,7 @@ public class GenerateXsd { NodeList parentNodes = javaTypeElement.getElementsByTagName("java-attributes"); StringBuffer sb = new StringBuffer(); if ( parentNodes.getLength() == 0 ) { - //System.out.println( "no java-attributes for java-type " + javaTypeName); + logger.trace( "no java-attributes for java-type " + javaTypeName); return ""; } @@ -354,17 +879,10 @@ public class GenerateXsd { String attrName = attr.getNodeName(); String attrValue = attr.getNodeValue(); - //System.out.println("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); + logger.trace("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); if ( attrName.equals("name")) xmlRootElementName = attrValue; } - /* - if ( javaTypeName.equals("RelationshipList")) { - System.out.println( "Skipping " + javaTypeName); - generatedJavaType.put(javaTypeName, null); - return ""; - } - */ Element parentElement = (Element)parentNodes.item(0); NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); @@ -381,14 +899,14 @@ public class GenerateXsd { sb1.append(" \n"); NodeList properties = GenerateXsd.locateXmlProperties(javaTypeElement); if (properties != null && useAnnotationsInXsd) { - //System.out.println("properties found for: " + xmlRootElementName); + logger.trace("properties found for: " + xmlRootElementName); sb1.append(" \r\n"); insertAnnotation(properties, false, "class", sb1, " "); sb1.append(" \r\n"); - } /*else { - System.out.println("no properties found for: " + xmlRootElementName); - }*/ + } else { + logger.trace("no properties found for: " + xmlRootElementName); + } sb1.append(" \n"); for ( int i = 0; i < xmlElementNodes.getLength(); ++i ) { @@ -406,7 +924,7 @@ public class GenerateXsd { String attrValue = attr.getNodeValue(); if ( attrName.equals("name")) { xmlElementWrapper = attrValue; - //System.out.println("found xml-element-wrapper " + xmlElementWrapper); + logger.trace("found xml-element-wrapper " + xmlElementWrapper); } } @@ -421,7 +939,7 @@ public class GenerateXsd { String attrName = attr.getNodeName(); String attrValue = attr.getNodeValue(); - //System.out.println("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); + logger.trace("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); if ( attrName.equals("name")) { elementName = attrValue; } @@ -460,33 +978,29 @@ public class GenerateXsd { sb1.append(" \r\n"); insertAnnotation(properties, false, "class", sb1, " "); sb1.append(" \r\n"); - } /*else { - System.out.println("no properties found for: " + xmlElementWrapper); - }*/ + } else { + logger.trace("no properties found for: " + xmlElementWrapper); + } sb1.append(" \n"); sb1.append(" "); } if ("Nodes".equals(addType)) { - //System.out.println ("Skipping nodes, temporary testing"); + logger.trace("Skipping nodes, temporary testing"); continue; } if ( addType != null ) { - //sb1.append(" \n"); } } - /* - if ( xmlRootElementName.equals("notify") || - xmlRootElementName.equals("relationship") || - xmlRootElementName.equals("relationship-data") || - xmlRootElementName.equals("related-to-property") ) - - sb1.append(" \n"); - */ sb1.append(" \n"); sb1.append(" \n"); sb1.append(" \n"); } - /* - 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(); - System.out.println("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); - if ( attrValue.equals("name")) - xmlRootElementName = attrValue; - } - */ if ( xmlElementNodes.getLength() < 1 ) { sb.append(" \n"); @@ -549,9 +1041,7 @@ public class GenerateXsd { generatedJavaType.put(javaTypeName, null); return sb.toString(); } - sb.append( sb1 ); - return sb.toString(); } @@ -576,8 +1066,6 @@ public class GenerateXsd { name = "extendsFrom"; } metadata.add(name + "=\"" + value.replaceAll("&", "&") + "\""); - //System.out.println("property name: " + name); - } } sb1.append( @@ -605,7 +1093,7 @@ public class GenerateXsd { return javaTypeElement; } } - System.out.println( "oxm file format error, missing java-type " + javaTypeName); + logger.error( "oxm file format error, missing java-type " + javaTypeName); return (Element) null; } @@ -626,7 +1114,7 @@ public class GenerateXsd { return javaTypeElement; } } - System.out.println( "oxm file format error, missing java-type " + javaTypeName); + logger.error( "oxm file format error, missing java-type " + javaTypeName); return (Element) null; } private static String getXmlRootElementName( String javaTypeName ) @@ -651,21 +1139,28 @@ public class GenerateXsd { attrName = attr.getNodeName(); attrValue = attr.getNodeValue(); - //System.out.println("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); if ( attrName.equals("name")) return (attrValue); } } } } - System.out.println( "oxm file format error, missing java-type " + javaTypeName); + logger.error( "oxm file format error, missing java-type " + javaTypeName); return null; } - public static String processOxmFile( File oxmFile, Version v ) + 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 || v.compareTo(Version.v12) < 0) { @@ -680,7 +1175,8 @@ public class GenerateXsd { " xmlns:annox=\"http://annox.dev.java.net\" \r\n" + " jaxb:extensionBindingPrefixes=\"annox\">\n\n"); } else { - sb.append("\n\n"); } @@ -689,8 +1185,14 @@ public class GenerateXsd { DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); DocumentBuilder dBuilder = dbFactory.newDocumentBuilder(); - Document doc = dBuilder.parse(oxmFile); - + 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; @@ -700,20 +1202,20 @@ public class GenerateXsd { if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } bindingElement = (Element) bindingsNodes.item(0); javaTypesNodes = bindingElement.getElementsByTagName("java-types"); if ( javaTypesNodes.getLength() < 1 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } javaTypesElement = (Element) javaTypesNodes.item(0); javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); if ( javaTypeNodes.getLength() < 1 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } @@ -732,11 +1234,11 @@ public class GenerateXsd { javaTypeName = attrValue; } if ( javaTypeName == null ) { - System.out.println( " has no name attribute in " + oxmFile ); + logger.error( " has no name attribute in " + oxmFile ); return null; } if ("Nodes".equals(javaTypeName)) { - //System.out.println("skipping Nodes entry (temporary feature)"); + logger.debug("skipping Nodes entry (temporary feature)"); continue; } if ( !generatedJavaType.containsKey(javaTypeName) ) { @@ -752,6 +1254,66 @@ public class GenerateXsd { 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 ) { @@ -778,7 +1340,7 @@ public class GenerateXsd { } 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 @@ -799,11 +1361,13 @@ public class GenerateXsd { Map edgeMap; String fromNode; String toNode; - String ruleKey; String direction; String multiplicity; String isParent; String hasDelTarget; + String deleteOtherV; + String preventDelete; + String description; EdgeDescription edgeDes; while( edgeRulesIterator.hasNext() ){ @@ -817,6 +1381,9 @@ public class GenerateXsd { } 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"); @@ -828,9 +1395,16 @@ public class GenerateXsd { 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); - result.add(edgeDes); + 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(); @@ -854,13 +1428,26 @@ public class GenerateXsd { 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; - - //Map addJavaType = new HashMap(); + StringBuilder definitionsLocalSb = new StringBuilder(256); + String useTag = null; String useOpId = null; @@ -871,38 +1458,11 @@ public class GenerateXsd { case "Business": case "LicenseManagement": case "CloudInfrastructure": - case "ExternalSystem": break; default: return null; } } - /* - if ( path == null ) - System.out.println( "processJavaTypeElementSwagger called with null path for javaTypeName " + javaTypeName); - */ - /* - if ( path == null || !(path.contains("cloud-infrastructure"))) - switch ( javaTypeName) { - case "Inventory": - useTag = null; - break; - - case "CloudInfrastructure": - case "Search": - case "Actions": - case "ServiceDesignAndCreation": - case "LicenseManagement": - case "Network": - if ( tag == null ) - useTag = javaTypeName; - - break; - default: - return null; - - } - */ if ( !javaTypeName.equals("Inventory") ) { if ( javaTypeName.equals("AaiInternal")) @@ -915,20 +1475,11 @@ public class GenerateXsd { useTag = javaTypeName; } - /* - if ( javaTypeName.equals("GenericVnf")) - System.out.println( "Processing " + javaTypeName); - else if ( javaTypeName.equals("Service")) - System.out.println( "Processing " + javaTypeName); - else if ( javaTypeName.equals("SitePair")) - System.out.println( "Processing " + javaTypeName); - */ NodeList parentNodes = javaTypeElement.getElementsByTagName("java-attributes"); if ( parentNodes.getLength() == 0 ) { - //System.out.println( "no java-attributes for java-type " + javaTypeName); + logger.trace( "no java-attributes for java-type " + javaTypeName); return ""; - } NamedNodeMap attributes; @@ -941,20 +1492,11 @@ public class GenerateXsd { String attrName = attr.getNodeName(); String attrValue = attr.getNodeValue(); - //System.out.println("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); + logger.trace("Found xml-root-element attribute: " + attrName + " with value: " + attrValue); if ( attrName.equals("name")) xmlRootElementName = attrValue; } - /* - if ( xmlRootElementName.equals("oam-networks")) - System.out.println( "xmlRootElement oam-networks with getItemData [" + getItemName + "]"); - */ - //already processed - /* - if ( generatedJavaType.containsKey(xmlRootElementName) ) { - return null; - } - */ + NodeList childNodes; Element childElement; NodeList xmlPropNodes = javaTypeElement.getElementsByTagName("xml-properties"); @@ -964,10 +1506,6 @@ public class GenerateXsd { Vector indexedProps = null; - /*System.out.println( "javaTypeName " + javaTypeName + " has xml-properties length " + xmlPropNodes.getLength()); - if ( path != null && path.equals("/network/generic-vnfs")) - System.out.println("path is " + "/network/generic-vnfs with getItemName " + getItemName); - */ if ( xmlPropNodes.getLength() > 0 ) { for ( int i = 0; i < xmlPropNodes.getLength(); ++i ) { @@ -993,8 +1531,6 @@ public class GenerateXsd { } if ( useValue == VALUE_DESCRIPTION && attrName.equals("value")) { pathDescriptionProperty = attrValue; - //break; - //System.out.println("found xml-element-wrapper " + xmlElementWrapper); } if ( attrValue.equals("indexedProps")) { useValue = VALUE_INDEXED_PROPS; @@ -1007,15 +1543,7 @@ public class GenerateXsd { } } } - //System.out.println("javaTypeName " + javaTypeName + " description " + pathDescriptionProperty); - - /* - if ( javaTypeName.equals("RelationshipList")) { - System.out.println( "Skipping " + javaTypeName); - generatedJavaType.put(javaTypeName, null); - return ""; - } - */ + logger.trace("javaTypeName " + javaTypeName + " description " + pathDescriptionProperty); Element parentElement = (Element)parentNodes.item(0); NodeList xmlElementNodes = parentElement.getElementsByTagName("xml-element"); @@ -1040,24 +1568,16 @@ public class GenerateXsd { if ( xmlRootElementName.equals("inventory")) path = ""; else if ( path == null ) - //path = "/aai/" + apiVersion; path = "/" + xmlRootElementName; else path += "/" + xmlRootElementName; st = new StringTokenizer(path, "/"); - /* - if ( path.equals("/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription")) - System.out.println("processing path /business/customers/customer/{global-customer-id}/service-subscriptions with tag " + tag); - */ boolean genPath = false; - /* - if ( path != null && path.equals("/network/generic-vnfs/generic-vnf")) - System.out.println("path is " + "/network/generic-vnfs/generic-vnf"); - */ + if ( st.countTokens() > 1 && getItemName == null ) { if ( appliedPaths.containsKey(path)) return null; - appliedPaths.put(path, null); + appliedPaths.put(path, xmlRootElementName); genPath = true; if ( path.contains("/relationship/") ) { // filter paths with relationship-list genPath = false; @@ -1075,23 +1595,7 @@ public class GenerateXsd { xmlElementElement = (Element)xmlElementNodes.item(i); if ( !xmlElementElement.getParentNode().isSameNode(parentElement)) continue; - /*childNodes = xmlElementElement.getElementsByTagName("xml-element-wrapper"); - 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; - //System.out.println("found xml-element-wrapper " + xmlElementWrapper); - } - } - } - */ valNodes = xmlElementElement.getElementsByTagName("xml-properties"); attrDescription = null; if ( valNodes.getLength() > 0 ) { @@ -1115,7 +1619,6 @@ public class GenerateXsd { } if ( useValue && attrName.equals("value")) { attrDescription = attrValue; - //System.out.println("found xml-element-wrapper " + xmlElementWrapper); } } @@ -1133,7 +1636,7 @@ public class GenerateXsd { String attrName = attr.getNodeName(); String attrValue = attr.getNodeValue(); - //System.out.println("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); + logger.trace("For " + xmlRootElementName + " Found xml-element attribute: " + attrName + " with value: " + attrValue); if ( attrName.equals("name")) { elementName = attrValue; @@ -1162,18 +1665,18 @@ public class GenerateXsd { if ( getItemName != null ) { if ( getItemName.equals("array") ) { if ( elementContainerType != null && elementContainerType.equals("java.util.ArrayList")) { - //System.out.println( " returning array " + elementName ); + logger.trace( " returning array " + elementName ); return elementName; } } else { // not an array check if ( elementContainerType == null || !elementContainerType.equals("java.util.ArrayList")) { - //System.out.println( " returning object " + elementName ); + logger.trace( " returning object " + elementName ); return elementName; } } - //System.out.println( " returning null" ); + logger.trace( " returning null" ); return null; } if ( elementIsRequired != null ) { @@ -1190,7 +1693,7 @@ public class GenerateXsd { } if ( elementIsKey != null ) { - sbParameters.append((" - name: " + elementName + "\n")); + sbParameters.append((" - name: " + elementName + "\n")); sbParameters.append((" in: path\n")); if ( attrDescription != null && attrDescription.length() > 0 ) sbParameters.append((" description: " + attrDescription + "\n")); @@ -1205,10 +1708,12 @@ public class GenerateXsd { sbParameters.append(" type: integer\n"); sbParameters.append(" format: int32\n"); } - if ( elementType.equals("java.lang.Boolean")) + 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")); @@ -1229,12 +1734,6 @@ public class GenerateXsd { if ( elementType.equals("java.lang.Boolean")) sbIndexedParams.append(" type: boolean\n"); } - - /* - if ( elementName != null && elementName.equals("inventory-item")) - System.out.println( "processing inventory-item elementName"); - */ - if ( isStandardType(elementType)) { sbProperties.append(" " + elementName + ":\n"); ++propertyCnt; @@ -1256,8 +1755,6 @@ public class GenerateXsd { sbProperties.append(" description: " + attrDescription + "\n"); } - //if ( addType != null && elementContainerType != null && elementContainerType.equals("java.util.ArrayList") ) { - if ( addTypeV != null ) { StringBuffer newPathParams = null; if ( pathParams != null ) { @@ -1293,21 +1790,17 @@ public class GenerateXsd { if ( itemName != null ) { if ( addType.equals("AaiInternal") ) { - //System.out.println( "addType AaiInternal, skip properties"); + 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 + "\"\n"); + sbProperties.append(" $ref: \"#/definitions/" + (itemName == "" ? "aai-internal" : itemName) + "\"\n"); if ( attrDescription != null && attrDescription.length() > 0 ) sbProperties.append(" description: " + attrDescription + "\n"); } } else { - /*itemName = processJavaTypeElementSwagger( addType, getJavaTypeElementSwagger(addType), - pathSb, definitionsSb, path, tag == null ? useTag : tag, useOpId, "other" ); - if ( itemName != null ) { - */ if ( elementContainerType != null && elementContainerType.equals("java.util.ArrayList")) { // need properties for getXmlRootElementName(addType) newPathParams = null; @@ -1343,55 +1836,16 @@ public class GenerateXsd { if ( attrDescription != null && attrDescription.length() > 0 ) sbProperties.append(" description: " + attrDescription + "\n"); ++propertyCnt; - /*} - else { - System.out.println(" unable to define swagger object for " + addType); - } - */ } - //if ( getItemName == null) looking for missing properties - //generatedJavaType.put(addType, null); } } } } if ( genPath ) { - /* - if ( useOpId.equals("CloudInfrastructureComplexesComplexCtagPools")) - System.out.println( "adding path CloudInfrastructureComplexesComplexCtagPools"); - */ - if ( !path.endsWith("/relationship") ) { - 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: \"#/definitions/" + xmlRootElementName + "\"\n"); - pathSb.append(" \"default\":\n"); - pathSb.append(" " + responsesUrl); - /* - pathSb.append(" \"200\":\n"); - pathSb.append(" description: successful operation\n"); - pathSb.append(" schema:\n"); - pathSb.append(" $ref: \"#/definitions/" + xmlRootElementName + "\"\n"); - pathSb.append(" \"404\":\n"); - pathSb.append(" description: resource was not found\n"); - pathSb.append(" \"400\":\n"); - pathSb.append(" description: bad request\n"); - */ - if ( path.indexOf('{') > 0 ) { + 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 ) @@ -1402,7 +1856,7 @@ public class GenerateXsd { pathSb.append(" parameters:\n"); pathSb.append(pathParams); } else - System.out.println( "null pathParams for " + useOpId); + logger.trace( "null pathParams for " + useOpId); if ( sbIndexedParams.toString().length() > 0 ) { if ( queryParams == null ) queryParams = sbIndexedParams.toString(); @@ -1415,7 +1869,7 @@ public class GenerateXsd { } pathSb.append(queryParams); } - } +// } } boolean skipPutDelete = false; // no put or delete for "all" if ( !path.endsWith("/relationship") ) { @@ -1426,103 +1880,18 @@ public class GenerateXsd { } if ( path.indexOf('{') > 0 && !opId.startsWith("Search") &&!skipPutDelete) { // add PUT - 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: create or update an existing " + xmlRootElementName + "\n"); - } - 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(" responses:\n"); - pathSb.append(" \"200\":\n"); - pathSb.append(" description: existing resource has been modified and there is a response buffer\n"); - pathSb.append(" \"201\":\n"); - pathSb.append(" description: new resource is created\n"); - pathSb.append(" \"202\":\n"); - pathSb.append(" description: action requested but may have taken other actions as well, which are returned in the response payload\n"); - pathSb.append(" \"204\":\n"); - pathSb.append(" description: existing resource has been modified and there is no response buffer\n"); - pathSb.append(" \"400\":\n"); - pathSb.append(" description: Bad Request will be returned if headers are missing\n"); - pathSb.append(" \"404\":\n"); - pathSb.append(" description: Not Found will be returned if an unknown URL is used\n"); - */ - pathSb.append(" parameters:\n"); - //pathSb.append(" - in: path\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: \"#/definitions/" + xmlRootElementName + "\"\n"); - /* - if ( queryParams != null ) { - pathSb.append(queryParams); - } - */ - // add DELETE - 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(" responses:\n"); - pathSb.append(" \"200\":\n"); - pathSb.append(" description: successful, the response includes an entity describing the status\n"); - pathSb.append(" \"204\":\n"); - pathSb.append(" description: successful, action has been enacted but the response does not include an entity\n"); - pathSb.append(" \"400\":\n"); - pathSb.append(" description: Bad Request will be returned if headers are missing\n"); - pathSb.append(" \"404\":\n"); - pathSb.append(" description: Not Found will be returned if an unknown URL is used\n"); - */ - pathSb.append(" parameters:\n"); - //pathSb.append(" - in: path\n"); - pathSb.append(pathParams); // for nesting + PutOperation put = new PutOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); + pathSb.append(put.toString()); 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"); + PatchOperation patch = new PatchOperation(useOpId, xmlRootElementName, tag, path, pathParams == null ? "" : pathParams.toString()); + pathSb.append(patch.toString1()); } - /* - if ( queryParams != null ) { - pathSb.append(queryParams); - } - */ + 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()); } } @@ -1531,11 +1900,13 @@ public class GenerateXsd { } 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) { + 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)); @@ -1549,51 +1920,94 @@ public class GenerateXsd { 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"); + definitionsSb.append(" description: |\n"); + definitionsLocalSb.append(" description: |\n"); - if ( pathDescriptionProperty != null ) + if ( pathDescriptionProperty != null ) { definitionsSb.append(" " + pathDescriptionProperty + "\n" ); - if (validEdges != null) + definitionsLocalSb.append(" " + pathDescriptionProperty + "\n" ); + } + if (validEdges != null) { definitionsSb.append(validEdges); + definitionsLocalSb.append(validEdges); + } } - if ( requiredCnt > 0 ) + 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 String generateSwaggerFromOxmFile( File oxmFile ) - { + 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 description: |\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("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"); - /* - sb.append("responses:\n"); - sb.append(" \"200\":\n"); - sb.append(" description: successful operation\n"); - sb.append(" \"404\":\n"); - sb.append(" description: resource was not found\n"); - sb.append(" \"400\":\n"); - sb.append(" description: bad request\n"); - */ + try { - File initialFile = new File("src/main/resources/dbedgerules/DbEdgeRules_" + apiVersion + ".json"); + 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); @@ -1604,7 +2018,14 @@ public class GenerateXsd { DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); DocumentBuilder dBuilder = dbFactory.newDocumentBuilder(); - Document doc = dBuilder.parse(oxmFile); + 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; @@ -1615,21 +2036,21 @@ public class GenerateXsd { if ( bindingsNodes == null || bindingsNodes.getLength() == 0 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } bindingElement = (Element) bindingsNodes.item(0); javaTypesNodes = bindingElement.getElementsByTagName("java-types"); if ( javaTypesNodes.getLength() < 1 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } javaTypesElement = (Element) javaTypesNodes.item(0); javaTypeNodes = javaTypesElement.getElementsByTagName("java-type"); if ( javaTypeNodes.getLength() < 1 ) { - System.out.println( "missing in " + oxmFile ); + logger.error( "missing in " + oxmFile ); return null; } @@ -1638,8 +2059,7 @@ public class GenerateXsd { Attr attr; StringBuffer pathSb = new StringBuffer(); - StringBuffer definitionsSb = new StringBuffer("definitions:\n"); - + StringBuffer definitionsSb = new StringBuffer(); for ( int i = 0; i < javaTypeNodes.getLength(); ++ i ) { javaTypeElement = (Element) javaTypeNodes.item(i); NamedNodeMap attributes = javaTypeElement.getAttributes(); @@ -1652,28 +2072,67 @@ public class GenerateXsd { javaTypeName = attrValue; } if ( javaTypeName == null ) { - System.out.println( " has no name attribute in " + oxmFile ); + logger.error( " has no name attribute in " + oxmFile ); return null; } if ( !generatedJavaType.containsKey(getXmlRootElementName(javaTypeName)) ) { - //generatedJavaType.put(javaTypeName, null); - //if ( javaTypeName.equals("search")||javaTypeName.equals("actions")) - processJavaTypeElementSwagger( javaTypeName, javaTypeElement, pathSb, definitionsSb, null, null, null, null, null, null, null); } } sb.append(pathSb); - //System.out.println( "definitions block\n" + definitionsSb.toString()); - sb.append(definitionsSb.toString()); - //sb.append(definitionsSb); - } catch (Exception e) { e.printStackTrace(); return null; } - //System.out.println("generated " + sb.toString()); + //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(); } @@ -1686,7 +2145,7 @@ public class GenerateXsd { Object nodeset = expr.evaluate(element, XPathConstants.NODESET); if (nodeset != null) { NodeList nodes = (NodeList) nodeset; - if (nodes.getLength() > 0) { + if (nodes != null && nodes.getLength() > 0) { Element xmlProperty = (Element)nodes.item(0); result = xmlProperty.getElementsByTagName("xml-property"); } @@ -1698,4 +2157,4 @@ public class GenerateXsd { return result; } -} +} \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/util/HttpsAuthClient.java b/aai-core/src/main/java/org/onap/aai/util/HttpsAuthClient.java index 24ba1ba8..5deb48ae 100644 --- a/aai-core/src/main/java/org/onap/aai/util/HttpsAuthClient.java +++ b/aai-core/src/main/java/org/onap/aai/util/HttpsAuthClient.java @@ -61,7 +61,7 @@ public class HttpsAuthClient{ // System.out.println("Jersey result: "); // System.out.println(res.getEntity(String.class).toString()); - + } catch (KeyManagementException e) { e.printStackTrace(); } catch (Exception e) { diff --git a/aai-core/src/main/java/org/onap/aai/util/HttpsAuthExternalClient.java b/aai-core/src/main/java/org/onap/aai/util/HttpsAuthExternalClient.java new file mode 100644 index 00000000..a984c1e6 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/HttpsAuthExternalClient.java @@ -0,0 +1,150 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright (C) 2017 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.FileInputStream; +import java.security.KeyManagementException; +import java.security.KeyStore; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.KeyManagerFactory; +import javax.net.ssl.TrustManagerFactory; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; + +import org.onap.aai.domain.yang.Customers; +import com.sun.jersey.api.client.Client; +import com.sun.jersey.api.client.ClientResponse; +import com.sun.jersey.api.client.config.ClientConfig; +import com.sun.jersey.api.client.config.DefaultClientConfig; +import com.sun.jersey.api.json.JSONConfiguration; +import com.sun.jersey.client.urlconnection.HTTPSProperties; + +public class HttpsAuthExternalClient { + + /** + * The main method. + * + * @param args the arguments + */ + public static void main(String[] args) { + try { + String url = AAIConfig.get(AAIConstants.AAI_SERVER_URL) + "business/customers"; + System.out.println("Making Jersey https call..."); + String keystore = args[0]; + String keypasswd = args[1]; + Client client = HttpsAuthExternalClient.getClient(keystore, keypasswd); + + ClientResponse res = client.resource(url) + .accept("application/json") + .header("X-TransactionId", "PROV001") + .header("X-FromAppId", "AAI") + .type("application/json") + .get(ClientResponse.class); + +// System.out.println("Jersey result: "); +// System.out.println(res.getEntity(String.class).toString()); + + Customers customers = res.getEntity(Customers.class); + System.out.println("Jersey result: "); + System.out.println("Number of customers: " + customers.getCustomer().size()); + + } catch (KeyManagementException e) { + e.printStackTrace(); + } catch (Exception e) { + e.printStackTrace(); + } + } + + + /** + * Gets the client. + * + * @param keystoreFileName the keystore file name + * @param keystorePassword the keystore password + * @return the client + * @throws Exception the exception + */ + public static Client getClient ( String keystoreFileName, String keystorePassword ) throws Exception { + + ClientConfig config = new DefaultClientConfig(); + config.getFeatures().put(JSONConfiguration.FEATURE_POJO_MAPPING, Boolean.TRUE); + config.getClasses().add(org.onap.aai.restcore.CustomJacksonJaxBJsonProvider.class); + Client client = null; + SSLContext ctx = null; + + try { + String truststore_path = AAIConstants.AAI_HOME_ETC_AUTH + AAIConfig.get(AAIConstants.AAI_TRUSTSTORE_FILENAME); + String truststore_password = AAIConfig.get(AAIConstants.AAI_TRUSTSTORE_PASSWD); + String keystore_path = AAIConstants.AAI_HOME_ETC_AUTH + keystoreFileName; + String keystore_password = keystorePassword; + + //System.setProperty("javax.net.ssl.trustStore", truststore_path); + //System.setProperty("javax.net.ssl.trustStorePassword", truststore_password); + HttpsURLConnection.setDefaultHostnameVerifier( new HostnameVerifier(){ + public boolean verify(String string,SSLSession ssls) { + return true; + } + }); + + ctx = SSLContext.getInstance("TLS"); + KeyManagerFactory kmf = null; + + + /**** kmf = KeyManagerFactory.getInstance("SunX509"); + FileInputStream fin = new FileInputStream(keystore_path); + KeyStore ks = KeyStore.getInstance("PKCS12"); + char[] pwd = keystore_password.toCharArray(); + ks.load(fin, pwd); + kmf.init(ks, pwd); + ***/ + + String alg = TrustManagerFactory.getDefaultAlgorithm(); + TrustManagerFactory tmf = TrustManagerFactory.getInstance(alg); + FileInputStream tin = new FileInputStream(truststore_path); + KeyStore ts = KeyStore.getInstance("PKCS12"); + char[] tpwd = truststore_password.toCharArray(); + ts.load(tin, tpwd); + tmf.init(ts); + + //ctx.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null); + // Updating key manager to null, to disable two way SSL + ctx.init(null, tmf.getTrustManagers(), null); + + config.getProperties().put(HTTPSProperties.PROPERTY_HTTPS_PROPERTIES, + new HTTPSProperties( new HostnameVerifier() { + @Override + public boolean verify( String s, SSLSession sslSession ) { + return true; + } + }, ctx)); + + client = Client.create(config); + // uncomment this line to get more logging for the request/response + // client.addFilter(new LoggingFilter(System.out)); + } catch (Exception e) { + throw e; + } + return client; + } + +} diff --git a/aai-core/src/main/java/org/onap/aai/util/Request.java b/aai-core/src/main/java/org/onap/aai/util/Request.java index 605aa2b9..46c891c2 100644 --- a/aai-core/src/main/java/org/onap/aai/util/Request.java +++ b/aai-core/src/main/java/org/onap/aai/util/Request.java @@ -33,10 +33,7 @@ import org.onap.aai.exceptions.AAIException; public class Request { - public static final String V2 = "v2"; - public static final String V3 = "v3"; - public static final String V4 = "v4"; - public static final String V5 = "v5"; + public static final String V12 = "v12"; public final String fromAppId; public final String transactionId; public final String path; @@ -73,7 +70,7 @@ public class Request { private String path; private RestObject restObj; private boolean oldServer; - private String apiVersion = Request.V4; + private String apiVersion = Request.V12; /** diff --git a/aai-core/src/main/java/org/onap/aai/util/RestController.java b/aai-core/src/main/java/org/onap/aai/util/RestController.java new file mode 100644 index 00000000..421946ef --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/util/RestController.java @@ -0,0 +1,469 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright (C) 2017 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.security.KeyManagementException; +import java.util.ArrayList; +import java.util.List; +import java.util.UUID; + +import org.onap.aai.exceptions.AAIException; +import org.onap.aai.logging.LoggingContext; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.type.TypeFactory; +import com.sun.jersey.api.client.Client; +import com.sun.jersey.api.client.ClientHandlerException; +import com.sun.jersey.api.client.ClientResponse; + +public class RestController { + + private static final String TARGET_NAME = "AAI"; + private static EELFLogger LOGGER = EELFManager.getInstance().getLogger(RestController.class); + + private static Client client = null; + + private String restSrvrBaseURL; + + //To do - Come up with helper function that will automatically + //generate the REST API path based on path parameter(s) and query parameter(s)! + public static final String REST_APIPATH_COMPLEXES = "cloud-infrastructure/complexes"; + public static final String REST_APIPATH_COMPLEX = "cloud-infrastructure/complexes/complex/"; + public static final String REST_APIPATH_PSERVERS = "cloud-infrastructure/pservers"; + public static final String REST_APIPATH_PSERVER = "cloud-infrastructure/pservers/pserver/"; + public static final String REST_APIPATH_PHYSICALLINKS = "network/physical-links/"; + public static final String REST_APIPATH_PHYSICALLINK = "network/physical-links/physical-link/"; + public static final String REST_APIPATH_PINTERFACES = "network/p-interfaces/"; + public static final String REST_APIPATH_PINTERFACE = "network/p-interfaces/p-interface/"; + public static final String REST_APIPATH_VPLSPES = "network/vpls-pes/"; + public static final String REST_APIPATH_VPLSPE = "network/vpls-pes/vpls-pe/"; + public static final String REST_APIPATH_UPDATE = "actions/update/"; + public static final String REST_APIPATH_SEARCH = "search/nodes-query?search-node-type="; + + public static final String REST_APIPATH_CLOUDREGION = "cloud-infrastructure/cloud-regions/cloud-region/"; + public static final String REST_APIPATH_TENANT = "cloud-infrastructure/tenants/tenant/"; + public static final String REST_APIPATH_VIRTUAL_DATA_CENTER = "cloud-infrastructure/virtual-data-centers/virtual-data-center/"; + public static final String REST_APIPATH_VIRTUAL_DATA_CENTERS = "cloud-infrastructure/virtual-data-centers/"; + //network/generic-vnfs/generic-vnf/{vnf-id} + public static final String REST_APIPATH_GENERIC_VNF = "network/generic-vnfs/generic-vnf/"; + public static final String REST_APIPATH_GENERIC_VNFS = "network/generic-vnfs"; + public static final String REST_APIPATH_L3_NETWORK = "network/l3-networks/l3-network/"; + public static final String REST_APIPATH_L3_NETWORKS = "network/l3-networks"; + public static final String REST_APIPATH_INSTANCE_GROUP = "network/instance-groups/instance-group"; + public static final String REST_APIPATH_INSTANCE_GROUPS = "network/instance-groups"; + + public static final String REST_APIPATH_VCE = "network/vces/vce/"; + + public static final String REST_APIPATH_SERVICE = "service-design-and-creation/services/service/"; + public static final String REST_APIPATH_LOGICALLINKS = "network/logical-links/"; + public static final String REST_APIPATH_LOGICALLINK = "network/logical-links/logical-link/"; + + /** + * Inits the rest client. + * + * @throws AAIException the AAI exception + */ + private static void initRestClient() throws AAIException + { + if (client == null) { + try { + client = HttpsAuthClient.getClient(); + } + catch (KeyManagementException e){ + throw new AAIException("AAI_7117", "KeyManagementException in REST call to DB: " + e.toString()); + } catch (Exception e) { + throw new AAIException("AAI_7117", " Exception in REST call to DB: " + e.toString()); + } + } + } + + /** + * Sets the rest srvr base URL. + * + * @param baseURL the base URL + * @throws AAIException the AAI exception + */ + public void SetRestSrvrBaseURL(String baseURL) throws AAIException + { + if (baseURL == null) + throw new AAIException("AAI_7117", "REST Server base URL cannot be null."); + restSrvrBaseURL = baseURL; + } + + /** + * Gets the rest srvr base URL. + * + * @return the rest srvr base URL + */ + public String getRestSrvrBaseURL() + { + return restSrvrBaseURL; + } + + + public static void Get(T t, String sourceID, String transId, String path, RestObject restObject, boolean oldserver) throws AAIException { + RestController.Get(t, sourceID, transId, path, restObject, oldserver, AAIConstants.AAI_RESOURCES_PORT); + } + /** + * To do - optimization and automation. Also make it as generic as possible. + * + * @param the generic type + * @param t the t + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @param restObject the rest object + * @param oldserver the oldserver + * @throws AAIException the AAI exception + */ + @SuppressWarnings("unchecked") + public static void Get(T t, String sourceID, String transId, String path, RestObject restObject, boolean oldserver, int port) throws AAIException { + String methodName = "Get"; + String url=""; + transId += ":" + UUID.randomUUID().toString(); + + LoggingContext.save(); + LoggingContext.partnerName(sourceID); + LoggingContext.targetEntity(TARGET_NAME); + LoggingContext.requestId(transId); + LoggingContext.serviceName(methodName); + LoggingContext.targetServiceName(methodName); + + LOGGER.debug(methodName + " start"); + + restObject.set(t); + + if (oldserver) + url = AAIConfig.get(AAIConstants.AAI_OLDSERVER_URL) + path; + else + url = String.format(AAIConstants.AAI_LOCAL_REST, port) + path; + initRestClient(); + LOGGER.debug(url + " for the get REST API"); + ClientResponse cres = client.resource(url) + .accept("application/json") + .header("X-TransactionId", transId) + .header("X-FromAppId", sourceID) + .header("Real-Time", "true") + .type("application/json") + .get(ClientResponse.class); + +// System.out.println("cres.EntityInputSream()="+cres.getEntityInputStream().toString()); +// System.out.println("cres.tostring()="+cres.toString()); + + if (cres.getStatus() == 200) { +// System.out.println(methodName + ": url=" + url); + t = (T) cres.getEntity(t.getClass()); + restObject.set(t); + LOGGER.debug(methodName + "REST api GET was successfull!"); + } else { + LoggingContext.restore(); +// System.out.println(methodName + ": url=" + url + " failed with status=" + cres.getStatus()); + throw new AAIException("AAI_7116", methodName +" with status="+cres.getStatus()+", url="+url); + } + + LoggingContext.restore(); + } + + /** + * Map json to object list. + * + * @param the generic type + * @param typeDef the type def + * @param json the json + * @param clazz the clazz + * @return the list + * @throws Exception the exception + */ + private static List mapJsonToObjectList(T typeDef,String json, Class clazz) throws Exception + { + List list; + ObjectMapper mapper = new ObjectMapper(); + System.out.println(json); + TypeFactory t = TypeFactory.defaultInstance(); + list = mapper.readValue(json, t.constructCollectionType(ArrayList.class,clazz)); + + return list; + } + + /** + * Put. + * + * @param the generic type + * @param t the t + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @throws AAIException the AAI exception + */ + public static void Put(T t, String sourceID, String transId, String path) throws AAIException { + Put( t, sourceID, transId, path, false, AAIConstants.AAI_RESOURCES_PORT); + } + + /** + * Put. + * + * @param the generic type + * @param t the t + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @throws AAIException the AAI exception + */ + public static void Put(T t, String sourceID, String transId, String path, boolean oldserver) throws AAIException { + Put( t, sourceID, transId, path, oldserver, AAIConstants.AAI_RESOURCES_PORT); + } + + /** + * Put. + * + * @param the generic type + * @param t the t + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @param oldserver the oldserver + * @throws AAIException the AAI exception + */ + public static void Put(T t, String sourceID, String transId, String path, boolean oldserver, int port) throws AAIException { + String methodName = "Put"; + String url=""; + transId += ":" + UUID.randomUUID().toString(); + + LoggingContext.save(); + LoggingContext.partnerName(sourceID); + LoggingContext.targetEntity(TARGET_NAME); + LoggingContext.requestId(transId); + LoggingContext.serviceName(methodName); + LoggingContext.targetServiceName(methodName); + + LOGGER.debug(methodName + " start"); + + initRestClient(); + + if (oldserver) + url = AAIConfig.get(AAIConstants.AAI_OLDSERVER_URL) + path; + else + url = String.format(AAIConstants.AAI_LOCAL_REST, port) + path; + + ClientResponse cres = client.resource(url) + .accept("application/json") + .header("X-TransactionId", transId) + .header("X-FromAppId", sourceID) + .header("Real-Time", "true") + .type("application/json") + .entity(t) + .put(ClientResponse.class); + +// System.out.println("cres.tostring()="+cres.toString()); + + int statuscode = cres.getStatus(); + if ( statuscode >= 200 && statuscode <= 299 ) { + LOGGER.debug(methodName+": url=" + url + ", request=" + path); + LoggingContext.restore(); + } else { + LoggingContext.restore(); + throw new AAIException("AAI_7116", methodName +" with status="+statuscode+", url="+url + ", msg=" + cres.getEntity(String.class)); + } + } + + public static void Delete(String sourceID, String transId, String path) throws AAIException { + RestController.Delete(sourceID, transId, path, AAIConstants.AAI_RESOURCES_PORT); + } + /** + * Delete. + * + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @throws AAIException the AAI exception + */ + public static void Delete(String sourceID, String transId, String path, int port) throws AAIException { + String methodName = "Delete"; + String url=""; + transId += ":" + UUID.randomUUID().toString(); + + LoggingContext.save(); + LoggingContext.partnerName(sourceID); + LoggingContext.targetEntity(TARGET_NAME); + LoggingContext.requestId(transId); + LoggingContext.serviceName(methodName); + LoggingContext.targetServiceName(methodName); + + LOGGER.debug(methodName + " start"); + + initRestClient(); + String request = "{}"; + url = String.format(AAIConstants.AAI_LOCAL_REST, port) + path; + ClientResponse cres = client.resource(url) + .accept("application/json") + .header("X-TransactionId", transId) + .header("X-FromAppId", sourceID) + .header("Real-Time", "true") + .type("application/json") + .entity(request) + .delete(ClientResponse.class); + + if (cres.getStatus() == 404) { // resource not found + LOGGER.info("Resource does not exist...: " + cres.getStatus() + + ":" + cres.getEntity(String.class)); + LoggingContext.restore(); + } else if (cres.getStatus() == 200 || cres.getStatus() == 204){ + LOGGER.info("Resource " + url + " deleted"); + LoggingContext.restore(); + } else { + LOGGER.error("Deleting Resource failed: " + cres.getStatus() + + ":" + cres.getEntity(String.class)); + LoggingContext.restore(); + throw new AAIException("AAI_7116", "Error during DELETE"); + } + } + + /** + * Post. + * + * @param the generic type + * @param t the t + * @param sourceID the source ID + * @param transId the trans id + * @param path the path + * @return the string + * @throws Exception the exception + */ + public static String Post(T t, String sourceID, String transId, String path) throws Exception { + String methodName = "Post"; + String url=""; + transId += ":" + UUID.randomUUID().toString(); + + LoggingContext.save(); + LoggingContext.partnerName(sourceID); + LoggingContext.targetEntity(TARGET_NAME); + LoggingContext.requestId(transId); + LoggingContext.serviceName(methodName); + LoggingContext.targetServiceName(methodName); + + LOGGER.debug(methodName + " start"); + + try { + + initRestClient(); + + url = AAIConfig.get(AAIConstants.AAI_SERVER_URL) + path; + + ClientResponse cres = client.resource(url) + .accept("application/json") + .header("X-TransactionId", transId) + .header("X-FromAppId", sourceID) + .header("Real-Time", "true") + .type("application/json") + .entity(t) + .post(ClientResponse.class); + + int statuscode = cres.getStatus(); + if ( statuscode >= 200 && statuscode <= 299 ) { + LOGGER.debug(methodName + "REST api POST was successful!"); + return cres.getEntity(String.class); + } else { + throw new AAIException("AAI_7116", methodName +" with status="+statuscode+", url="+url + ", msg=" + cres.getEntity(String.class)); + } + + } catch (AAIException e) { + throw new AAIException("AAI_7116", methodName + " with url="+url+ ", Exception: " + e.toString()); + } catch (Exception e) + { + throw new AAIException("AAI_7116", methodName + " with url="+url+ ", Exception: " + e.toString()); + + } + finally { + LoggingContext.restore(); + } + } + + + /** + * Gets the single instance of RestController. + * + * @param the generic type + * @param clazz the clazz + * @return single instance of RestController + * @throws IllegalAccessException the illegal access exception + * @throws InstantiationException the instantiation exception + */ + public static T getInstance(Class clazz) throws IllegalAccessException, InstantiationException + { + return clazz.newInstance(); + } + + /** + * Does resource exist. + * + * @param the generic type + * @param resourcePath the resource path + * @param resourceClassName the resource class name + * @param fromAppId the from app id + * @param transId the trans id + * @return the t + */ + /* + * DoesResourceExist + * + * To check whether a resource exist or get a copy of the existing version of the resource + * + * Resourcepath: should contain the qualified resource path (including encoded unique key identifier value), + * resourceClassName: is the canonical name of the resource class name, + * fromAppId: + * transId: + * + * Will return null (if the resource doesnā€™t exist) (or) + * Will return the specified resource from the Graph. + * + * Example: + * LogicalLink llink = new LogicalLink(); + * String resourceClassName = llink.getClass().getCanonicalName(); + * llink = RestController.DoesResourceExist("network/logical-links/logical-link/" + , resourceClassName, fromAppId, transId); + */ + public static T DoesResourceExist(String resourcePath, String resourceClassName, String fromAppId, String transId) { + + try { + + RestObject restObj = new RestObject(); + @SuppressWarnings("unchecked") + T resourceObj = (T)getInstance(Class.forName(resourceClassName)); + restObj.set(resourceObj); + RestController.Get(resourceObj, fromAppId, transId, resourcePath, restObj, false, AAIConstants.AAI_RESOURCES_PORT); + + resourceObj = restObj.get(); + if (resourceObj != null) + return resourceObj; + + } catch (AAIException e) { + + } catch (ClientHandlerException che) { + + }catch (Exception e) { + + } + + return null; + } + +} diff --git a/aai-core/src/main/java/org/onap/aai/util/StoreNotificationEvent.java b/aai-core/src/main/java/org/onap/aai/util/StoreNotificationEvent.java index 96dbfeb4..0ad33cb9 100644 --- a/aai-core/src/main/java/org/onap/aai/util/StoreNotificationEvent.java +++ b/aai-core/src/main/java/org/onap/aai/util/StoreNotificationEvent.java @@ -49,7 +49,11 @@ public class StoreNotificationEvent { * Instantiates a new store notification event. */ public StoreNotificationEvent(String transactionId, String sourceOfTruth) { - this.messageProducer = new AAIDmaapEventJMSProducer(); + this(new AAIDmaapEventJMSProducer(), transactionId, sourceOfTruth); + } + + public StoreNotificationEvent(AAIDmaapEventJMSProducer producer, String transactionId, String sourceOfTruth) { + this.messageProducer = producer; this.transactionId = transactionId; this.sourceOfTruth = sourceOfTruth; } @@ -64,7 +68,7 @@ public class StoreNotificationEvent { * @throws AAIException * the AAI exception */ - public void storeEvent(NotificationEvent.EventHeader eh, Object obj) throws AAIException { + public String storeEvent(NotificationEvent.EventHeader eh, Object obj) throws AAIException { if (obj == null) { throw new AAIException("AAI_7350"); @@ -123,6 +127,7 @@ public class StoreNotificationEvent { PojoUtils pu = new PojoUtils(); String entityJson = pu.getJsonFromObject(ne); sendToDmaapJmsQueue(entityJson); + return entityJson; } catch (Exception e) { throw new AAIException("AAI_7350", e); } @@ -214,7 +219,7 @@ public class StoreNotificationEvent { } } - public void storeEvent(Loader loader, Introspector eventHeader, Introspector obj) throws AAIException { + public String storeEvent(Loader loader, Introspector eventHeader, Introspector obj) throws AAIException { if (obj == null) { throw new AAIException("AAI_7350"); } @@ -271,6 +276,7 @@ public class StoreNotificationEvent { String entityJson = notificationEvent.marshal(false); sendToDmaapJmsQueue(entityJson); + return entityJson; } catch (JSONException e) { throw new AAIException("AAI_7350", e); } catch (AAIUnknownObjectException e) { diff --git a/aai-core/src/main/java/org/onap/aai/util/UniquePropertyCheck.java b/aai-core/src/main/java/org/onap/aai/util/UniquePropertyCheck.java index ae2cdaae..72e5380f 100644 --- a/aai-core/src/main/java/org/onap/aai/util/UniquePropertyCheck.java +++ b/aai-core/src/main/java/org/onap/aai/util/UniquePropertyCheck.java @@ -32,6 +32,8 @@ import org.apache.tinkerpop.gremlin.structure.Graph; import org.apache.tinkerpop.gremlin.structure.Vertex; import org.apache.tinkerpop.gremlin.structure.VertexProperty; import org.onap.aai.exceptions.AAIException; +import org.onap.aai.logging.LoggingContext; +import org.onap.aai.logging.LoggingContext.StatusCode; import org.slf4j.MDC; import com.att.eelf.configuration.Configuration; @@ -39,8 +41,7 @@ import com.att.eelf.configuration.EELFLogger; import com.att.eelf.configuration.EELFManager; import com.thinkaurelius.titan.core.TitanFactory; import com.thinkaurelius.titan.core.TitanGraph; - - +import org.onap.aai.dbmap.AAIGraphConfig; public class UniquePropertyCheck { @@ -61,11 +62,24 @@ public class UniquePropertyCheck { props.setProperty(Configuration.PROPERTY_LOGGING_FILE_NAME, "uniquePropertyCheck-logback.xml"); props.setProperty(Configuration.PROPERTY_LOGGING_FILE_PATH, AAIConstants.AAI_HOME_ETC_APP_PROPERTIES); EELFLogger logger = EELFManager.getInstance().getLogger(UniquePropertyCheck.class.getSimpleName()); + + LoggingContext.init(); + LoggingContext.partnerName(FROMAPPID); + LoggingContext.serviceName(AAIConstants.AAI_RESOURCES_MS); + LoggingContext.component(COMPONENT); + LoggingContext.targetEntity(AAIConstants.AAI_RESOURCES_MS); + LoggingContext.targetServiceName("main"); + LoggingContext.requestId(TRANSID); + LoggingContext.statusCode(StatusCode.COMPLETE); + LoggingContext.responseCode(LoggingContext.SUCCESS); + MDC.put("logFilenameAppender", UniquePropertyCheck.class.getSimpleName()); if( args == null || args.length != 1 ){ String msg = "usage: UniquePropertyCheck propertyName \n"; System.out.println(msg); + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.BUSINESS_PROCESS_ERROR); logAndPrint(logger, msg ); System.exit(1); } @@ -75,26 +89,34 @@ public class UniquePropertyCheck { try { AAIConfig.init(); System.out.println(" ---- NOTE --- about to open graph (takes a little while)--------\n"); - TitanGraph tGraph = TitanFactory.open(AAIConstants.REALTIME_DB_CONFIG); + TitanGraph tGraph = TitanFactory.open(new AAIGraphConfig.Builder(AAIConstants.REALTIME_DB_CONFIG).forService(UniquePropertyCheck.class.getSimpleName()).withGraphType("realtime").buildConfiguration()); if( tGraph == null ) { + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); logAndPrint(logger, " Error: Could not get TitanGraph "); System.exit(1); } graph = tGraph.newTransaction(); if( graph == null ){ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.AVAILABILITY_TIMEOUT_ERROR); logAndPrint(logger, "could not get graph object in UniquePropertyCheck() \n"); System.exit(0); } } catch (AAIException e1) { String msg = "Threw Exception: [" + e1.toString() + "]"; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.UNKNOWN_ERROR); logAndPrint(logger, msg); System.exit(0); } catch (Exception e2) { String msg = "Threw Exception: [" + e2.toString() + "]"; + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.UNKNOWN_ERROR); logAndPrint(logger, msg); System.exit(0); } @@ -180,6 +202,8 @@ public class UniquePropertyCheck { } } catch( Exception e2 ){ + LoggingContext.statusCode(StatusCode.ERROR); + LoggingContext.responseCode(LoggingContext.DATA_ERROR); logAndPrint(logger, "Threw Exception: [" + e2.toString() + "]"); } finally { diff --git a/aai-core/src/main/java/org/onap/aai/util/swagger/GenerateSwagger.java b/aai-core/src/main/java/org/onap/aai/util/swagger/GenerateSwagger.java index a85b548e..9d36c0e8 100644 --- a/aai-core/src/main/java/org/onap/aai/util/swagger/GenerateSwagger.java +++ b/aai-core/src/main/java/org/onap/aai/util/swagger/GenerateSwagger.java @@ -26,6 +26,7 @@ import com.fasterxml.jackson.dataformat.yaml.snakeyaml.constructor.SafeConstruct import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; +import org.onap.aai.introspection.Version; import java.io.*; import java.util.*; @@ -37,7 +38,11 @@ public class GenerateSwagger { public static final String DEFAULT_WIKI = ""; public static final String DEFAULT_SCHEMA_DIR = "../aai-schema"; - public static final String CURRENT_VERSION = "v11"; + public static final String CURRENT_VERSION = Version. getLatest().toString(); + //if the program is run from aai-common, use this directory as default" + public static final String ALT_SCHEMA_DIR = "aai-schema"; + //used to check to see if program is run from aai-core + public static final String DEFAULT_RUN_DIR = "aai-core"; public static void main(String[] args) throws IOException, TemplateException { @@ -46,8 +51,14 @@ public class GenerateSwagger { String wikiLink = System.getProperty("aai.wiki.link"); if(schemaDir == null){ - System.out.println("Warning: Schema directory is not set so using default schema dir: " + DEFAULT_SCHEMA_DIR); - schemaDir = DEFAULT_SCHEMA_DIR; + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(DEFAULT_RUN_DIR)) { + System.out.println("Warning: Schema directory is not set so using default schema dir: " + ALT_SCHEMA_DIR); + schemaDir = ALT_SCHEMA_DIR; + } + else { + System.out.println("Warning: Schema directory is not set so using default schema dir: " + DEFAULT_SCHEMA_DIR); + schemaDir = DEFAULT_SCHEMA_DIR; + } } if(versionToGenerate == null){ @@ -136,8 +147,13 @@ public class GenerateSwagger { Configuration configuration = new Configuration(); configuration.setClassForTemplateLoading(Api.class, "/"); - configuration.setDirectoryForTemplateLoading(new File("src/main/resources/")); - + String resourcePath = "src/main/resources"; + if(System.getProperty("user.dir") != null && !System.getProperty("user.dir").contains(DEFAULT_RUN_DIR)) { + configuration.setDirectoryForTemplateLoading(new File(DEFAULT_RUN_DIR + "/" + resourcePath)); + } + else { + configuration.setDirectoryForTemplateLoading(new File(resourcePath)); + } Template template = configuration.getTemplate("swagger.html.ftl"); String outputDirStr = schemaDir + "/src/main/resources/aai_swagger_html"; diff --git a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v10.json b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v10.json index e7a2e489..1c683237 100644 --- a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v10.json +++ b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v10.json @@ -1,21 +1,21 @@ { "rules": [ { - "from": "ipsec-configuration", - "to": "vig-server", - "label": "hasVigServer", + "from": "allotted-resource", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "multicast-configuration", - "label": "uses", + "from": "allotted-resource", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -25,107 +25,95 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "allotted-resource", + "to": "l3-network", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-constraint", - "to": "constrained-element-set", - "label": "uses", + "from": "allotted-resource", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "l-interface", - "label": "has", + "from": "allotted-resource", + "to": "vlan", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vf-module", - "label": "has", + "from": "tunnel-xconnect", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "p-interface", - "label": "usesPInterface", + "from": "availability-zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "model-element", - "to": "model-constraint", - "label": "uses", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "connector", - "to": "virtual-data-center", - "label": "contains", + "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": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-element", - "label": "connectsTo", + "from": "availability-zone", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "vpn-binding", - "label": "uses", + "from": "cloud-region", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -133,381 +121,405 @@ "default": "true" }, { - "from": "tenant", - "to": "vserver", - "label": "owns", + "from": "cloud-region", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "flavor", - "label": "hasFlavor", + "from": "cloud-region", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "vlan", - "label": "hasVlan", + "from": "dvs-switch", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "flavor", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "allotted-resource", - "to": "network-policy", - "label": "uses", + "from": "group-assignment", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vpls-pe", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "image", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "vnfc", - "label": "hosts", + "from": "oam-network", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "instance-group", - "to": "model", - "label": "targets", + "from": "snapshot", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "tenant", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "volume-group", - "label": "has", + "from": "volume-group", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "pnf", - "label": "uses", + "from": "complex", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "ctag-assignment", - "label": "hasCtagAssignment", + "from": "ctag-pool", + "to": "complex", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "service-instance", - "label": "hasServiceInstance", + "from": "connector", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "service-instance", - "label": "dependsOn", + "from": "metadatum", + "to": "connector", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "flavor", - "label": "has", + "from": "element-choice-set", + "to": "constrained-element-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "instance-group", - "label": "isMemberOf", + "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": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "pserver", - "label": "runsOnPserver", + "from": "service-subscription", + "to": "customer", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "pnf", - "label": "bridgedTo", + "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": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "virtual-data-center", - "to": "generic-vnf", - "label": "hasVNF", + "from": "model-element", + "to": "element-choice-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "p-interface", - "label": "hasPinterface", + "from": "entitlement", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "vf-module", - "label": "isPartOf", + "from": "generic-vnf", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "complex", - "to": "ctag-pool", - "label": "hasCtagPool", + "from": "generic-vnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "constrained-element-set", - "to": "element-choice-set", - "label": "uses", + "from": "generic-vnf", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "generic-vnf", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "physical-link", - "label": "usesPhysicalLink", + "from": "generic-vnf", + "to": "license-key-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-ver", - "label": "isA", + "from": "generic-vnf", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "image", - "label": "hasImage", + "from": "vnfc", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "complex", - "label": "locatedIn", + "from": "generic-vnf", + "to": "vnf-image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "tenant", - "to": "l3-network", - "label": "usesL3Network", + "from": "generic-vnf", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "generic-vnf", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "complex", - "label": "existsIn", + "from": "lag-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "license", + "to": "generic-vnf", + "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" + }, + { + "from": "l-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "cloud-region", - "label": "existsIn", + "from": "network-profile", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -517,23 +529,23 @@ "default": "true" }, { - "from": "oam-network", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "service-instance", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "zone", - "label": "isMemberOf", + "from": "site-pair-set", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -541,81 +553,81 @@ "default": "true" }, { - "from": "customer", - "to": "service-subscription", - "label": "subscribesTo", + "from": "vf-module", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "segmentation-assignment", - "label": "has", + "from": "pserver", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "vce", - "to": "license", - "label": "has", + "from": "tenant", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "related-lookup", - "label": "uses", + "from": "metadatum", + "to": "image", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "p-interface", - "label": "hasPinterface", + "from": "instance-group", + "to": "model", + "label": "org.onap.relationships.inventory.Targets", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "newvce", - "to": "l-interface", - "label": "hasLInterface", + "from": "vig-server", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "l3-network", - "label": "isPartOf", + "from": "l3-interface-ipv4-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -625,23 +637,11 @@ "default": "true" }, { - "from": "p-interface", - "to": "logical-link", - "label": "usesLogicalLink", - "direction": "OUT", - "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "vserver", - "label": "runsOnVserver", + "from": "l3-interface-ipv4-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -649,11 +649,11 @@ "default": "true" }, { - "from": "pserver", - "to": "availability-zone", - "label": "existsIn", + "from": "l3-interface-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -661,105 +661,81 @@ "default": "true" }, { - "from": "vpls-pe", - "to": "lag-interface", - "label": "hasLAGinterface", + "from": "l3-interface-ipv6-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "vnfc", - "label": "uses", - "direction": "OUT", - "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "service-instance", - "label": "hasInstance", + "from": "l3-interface-ipv6-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "model", - "label": "relatedTo", + "from": "l3-interface-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vf-module", - "to": "vnfc", - "label": "uses", + "from": "ctag-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "complex", - "label": "locatedIn", + "from": "l3-network", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "model-ver", - "to": "metadatum", - "label": "hasMetaData", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "entitlement", - "label": "has", + "from": "l3-network", + "to": "route-table-reference", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "availability-zone", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "l3-network", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -769,23 +745,23 @@ "default": "true" }, { - "from": "vserver", - "to": "volume", - "label": "hasVolume", + "from": "segmentation-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", + "from": "service-instance", "to": "l3-network", - "label": "isMemberOf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -793,105 +769,93 @@ "default": "true" }, { - "from": "cloud-region", - "to": "zone", - "label": "isMemberOf", + "from": "subnet", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "service-instance", - "label": "hasInstance", + "from": "lag-interface", + "to": "lag-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "route-table-reference", - "label": "uses", + "from": "lag-interface", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "model-element", - "to": "constrained-element-set", - "label": "connectsTo", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "dvs-switch", - "to": "availability-zone", - "label": "existsIn", + "from": "lag-interface", + "to": "p-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", + "from": "l-interface", "to": "lag-interface", - "label": "hasLAGInterface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "availability-zone", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "complex", - "label": "locatedIn", + "from": "l3-interface-ipv6-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "vlan", - "label": "isPartOf", + "from": "l-interface", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -901,203 +865,227 @@ "default": "true" }, { - "from": "zone", - "to": "complex", - "label": "existsIn", + "from": "l-interface", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair", - "to": "class-of-service", - "label": "hasClassOfService", + "from": "l-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "sriov-vf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "element-choice-set", - "to": "model-element", - "label": "has", + "from": "vlan", + "to": "l-interface", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "ctag-pool", - "to": "availability-zone", - "label": "supportsAvailabilityZone", + "from": "logical-link", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "network-policy", - "label": "uses", + "from": "logical-link", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "port-group", - "label": "hasPortGroup", + "from": "logical-link", + "to": "lag-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "complex", - "label": "locatedIn", + "from": "logical-link", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnf-image", - "label": "usesVnfImage", + "from": "logical-link", + "to": "pnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair-set", - "to": "routing-instance", - "label": "hasRoutingInstance", + "from": "logical-link", + "to": "pserver", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vlan", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "logical-link", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "model-ver", + "to": "model", + "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" }, { - "from": "generic-vnf", - "to": "l-interface", - "label": "hasLInterface", + "from": "constrained-element-set", + "to": "model-constraint", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "constrained-element-set", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "generic-vnf", - "label": "isPartOf", + "from": "model-constraint", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license", - "label": "has", + "from": "model-element", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "zone", - "label": "isMemberOf", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "lag-interface", - "to": "logical-link", - "label": "uses", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "named-query", + "to": "model", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1105,177 +1093,177 @@ "default": "true" }, { - "from": "vce", - "to": "vserver", - "label": "runsOnVserver", + "from": "named-query-element", + "to": "named-query", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "named-query-element", + "to": "model", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "volume-group", - "label": "uses", + "from": "named-query-element", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "pserver", - "label": "bridgedTo", + "from": "property-constraint", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "oam-network", - "label": "has", + "from": "related-lookup", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "dvs-switch", - "label": "has", + "from": "l-interface", + "to": "newvce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "has", + "from": "oam-network", + "to": "complex", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "uses", + "from": "oam-network", + "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" + }, + { + "from": "l-interface", + "to": "p-interface", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "l3-network", - "label": "uses", + "from": "p-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "group-assignment", - "label": "has", + "from": "p-interface", + "to": "physical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "group-assignment", - "to": "tenant", - "label": "has", + "from": "lag-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "p-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "virtual-data-center", - "to": "logical-link", - "label": "contains", + "from": "pnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "named-query-element", - "to": "named-query-element", - "label": "connectsTo", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "connector", - "label": "uses", + "from": "pnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1285,153 +1273,141 @@ "default": "true" }, { - "from": "lag-interface", - "to": "lag-link", - "label": "usesLAGLink", + "from": "pnf", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "cloud-region", - "label": "locatedIn", + "from": "cvlan-tag", + "to": "port-group", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "generic-vnf", - "label": "bridgedTo", + "from": "lag-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "entitlement", - "label": "has", + "from": "p-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "l3-network", - "label": "uses", + "from": "pserver", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "sriov-vf", - "label": "has", + "from": "pserver", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "model", - "label": "isA", + "from": "pserver", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "group-assignment", - "to": "pserver", - "label": "has", + "from": "pserver", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "snapshot", - "label": "has", + "from": "site-pair", + "to": "routing-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "cloud-region", - "to": "tenant", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "image", - "label": "has", + "from": "allotted-resource", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "model-ver", - "to": "model-element", - "label": "startsWith", + "from": "metadatum", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "service-instance", - "to": "cvlan-tag", - "label": "hasIPAGFacingVLAN", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1441,21 +1417,9 @@ "default": "true" }, { - "from": "vserver", - "to": "l-interface", - "label": "hasLInterface", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "service-instance", + "to": "connector", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1465,71 +1429,71 @@ "default": "true" }, { - "from": "pnf", - "to": "lag-interface", - "label": "has", + "from": "service-instance", + "to": "ctag-assignment", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "snapshot", - "label": "uses", + "from": "service-instance", + "to": "cvlan-tag", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "property-constraint", - "label": "uses", + "from": "service-instance", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-subscription", - "to": "service-instance", - "label": "hasInstance", + "from": "service-instance", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "service-instance", - "to": "logical-link", - "label": "uses", + "to": "pnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "service-instance", + "to": "service-instance", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1537,11 +1501,11 @@ "default": "true" }, { - "from": "tenant", - "to": "service-subscription", - "label": "relatedTo", + "from": "service-instance", + "to": "vlan", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1549,45 +1513,45 @@ "default": "true" }, { - "from": "vserver", - "to": "pserver", - "label": "runsOnPserver", + "from": "service-instance", + "to": "service-subscription", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "vlan", - "label": "dependsOn", + "from": "class-of-service", + "to": "site-pair", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "metadatum", - "label": "hasMetaData", + "from": "routing-instance", + "to": "site-pair-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "instance-group", - "label": "isMemberOf", + "from": "service-subscription", + "to": "tenant", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1597,59 +1561,71 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "tenant", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "lag-link", - "label": "usesLAGLink", + "from": "vserver", + "to": "tenant", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "entitlement", + "to": "vce", + "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" }, { - "from": "l3-interface-ipv4-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "license", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "subnet", - "label": "hasSubnet", + "from": "port-group", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "tenant", - "label": "belongsTo", + "from": "service-instance", + "to": "vce", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -1657,11 +1633,11 @@ "default": "true" }, { - "from": "cloud-region", - "to": "complex", - "label": "locatedIn", + "from": "vce", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1669,81 +1645,81 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "l3-network", - "label": "usesL3Network", + "from": "vce", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "availability-zone", - "to": "complex", - "label": "groupsResourcesIn", + "from": "vce", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "vf-module", + "to": "l3-network", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "named-query-element", - "label": "startsWith", + "from": "vf-module", + "to": "vnfc", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "service-instance", - "to": "ctag-assignment", - "label": "uses", + "from": "vf-module", + "to": "volume-group", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { "from": "generic-vnf", - "to": "ipsec-configuration", - "label": "uses", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "site-pair-set", - "label": "hasSitePairSet", + "from": "logical-link", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1753,231 +1729,255 @@ "default": "true" }, { - "from": "model", - "to": "model-ver", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "metadatum", - "label": "hasMetaData", + "from": "l3-interface-ipv6-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "network-profile", - "label": "hasNetworkProfile", + "from": "vlan", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "volume-group", - "label": "uses", + "from": "vlan", + "to": "multicast-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "logical-link", - "label": "uses", + "from": "tenant", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "volume-group", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "port-group", - "to": "cvlan-tag", - "label": "hasCTag", + "from": "lag-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "p-interface", - "label": "hasPinterface", + "from": "p-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "image", - "to": "metadatum", - "label": "hasMetaDatum", + "from": "vpls-pe", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "license-key-resource", - "label": "uses", + "from": "vpls-pe", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", + "from": "route-target", "to": "vpn-binding", - "label": "usesVpnBinding", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "l-interface", + "to": "vserver", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "vf-module", + "to": "vserver", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "complex", - "to": "l3-network", - "label": "usesL3Network", + "from": "vnfc", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "oam-network", - "to": "complex", - "label": "definedFor", + "from": "vserver", + "to": "flavor", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "vserver", + "to": "image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "routing-instance", - "to": "site-pair", - "label": "hasSitePair", + "from": "vserver", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "vserver", + "to": "snapshot", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpn-binding", - "to": "route-target", - "label": "has", + "from": "vserver", + "to": "volume", + "label": "tosca.relationships.AttachesTo", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "${direction}", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "tunnel-xconnect", - "label": "has", + "from": "metadatum", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "instance-group", - "label": "isMemberOf", + "from": "zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" } ] diff --git a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v11.json b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v11.json index e369390b..a32ba86e 100644 --- a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v11.json +++ b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v11.json @@ -61,11 +61,11 @@ "default": "true" }, { - "from": "vlan", - "to": "multicast-configuration", - "label": "uses", + "from": "allotted-resource", + "to": "allotted-resource", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -73,23 +73,23 @@ "default": "true" }, { - "from": "vnfc", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "allotted-resource", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "allotted-resource", - "to": "l-interface", - "label": "uses", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -97,57 +97,33 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "vf-module", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "logical-link", - "to": "vpn-binding", - "label": "uses", + "from": "allotted-resource", + "to": "l3-network", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "flavor", - "label": "hasFlavor", + "from": "allotted-resource", + "to": "l-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "l-interface", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "allotted-resource", "to": "network-policy", - "label": "uses", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2ONE", "contains-other-v": "NONE", @@ -157,93 +133,93 @@ "default": "true" }, { - "from": "vserver", - "to": "vnfc", - "label": "hosts", + "from": "allotted-resource", + "to": "vlan", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "cloud-region", - "to": "volume-group", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "service-instance", - "label": "hasServiceInstance", + "from": "allotted-resource", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "service-instance", - "label": "dependsOn", + "from": "tunnel-xconnect", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "flavor", - "label": "has", + "from": "availability-zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "pserver", - "label": "runsOnPserver", + "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": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vip-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "availability-zone", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "cloud-region", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", + "direction": "OUT", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "logical-link", - "to": "pnf", - "label": "bridgedTo", + "from": "cloud-region", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -253,189 +229,201 @@ "default": "true" }, { - "from": "virtual-data-center", - "to": "generic-vnf", - "label": "hasVNF", + "from": "cloud-region", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "p-interface", - "label": "hasPinterface", + "from": "dvs-switch", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vip-ipv4-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "flavor", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "pnf", - "label": "hostedOn", + "from": "group-assignment", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "p-interface", - "to": "physical-link", - "label": "usesPhysicalLink", + "from": "image", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-ver", - "label": "isA", + "from": "oam-network", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pnf", - "to": "complex", - "label": "locatedIn", + "from": "snapshot", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "tenant", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "oam-network", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "vip-ipv4-address-list", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pserver", - "to": "zone", - "label": "isMemberOf", + "from": "vip-ipv6-address-list", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-network", - "to": "segmentation-assignment", - "label": "has", + "from": "volume-group", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "complex", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "configuration", - "to": "metadatum", - "label": "owns", + "from": "ctag-pool", + "to": "complex", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "license", - "label": "has", + "from": "configuration", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "related-lookup", - "label": "uses", + "from": "configuration", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "p-interface", - "label": "hasPinterface", + "from": "metadatum", + "to": "configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vip-ipv6-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "connector", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -445,59 +433,59 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "vserver", - "label": "runsOnVserver", + "from": "metadatum", + "to": "connector", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "lag-interface", - "label": "hasLAGinterface", + "from": "element-choice-set", + "to": "constrained-element-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnfc", - "label": "uses", + "from": "ctag-pool", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-network", - "to": "service-instance", - "label": "hasInstance", + "from": "service-subscription", + "to": "customer", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "model", - "label": "relatedTo", + "from": "dvs-switch", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -505,33 +493,33 @@ "default": "true" }, { - "from": "vf-module", - "to": "vnfc", - "label": "uses", + "from": "model-element", + "to": "element-choice-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "entitlement", - "label": "has", + "from": "entitlement", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vip-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "generic-vnf", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -541,9 +529,9 @@ "default": "true" }, { - "from": "availability-zone", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "generic-vnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -553,33 +541,21 @@ "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "l3-network", - "label": "isMemberOf", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "cloud-region", - "to": "vip-ipv6-address-list", - "label": "hasIpAddress", + "from": "generic-vnf", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "route-table-reference", - "label": "uses", + "from": "generic-vnf", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -589,45 +565,45 @@ "default": "true" }, { - "from": "model-element", - "to": "constrained-element-set", - "label": "connectsTo", + "from": "generic-vnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "configuration", - "to": "allotted-resource", - "label": "uses", + "from": "generic-vnf", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "configuration", - "to": "allotted-resource", - "label": "uses", + "from": "generic-vnf", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "dvs-switch", - "to": "availability-zone", - "label": "existsIn", + "from": "generic-vnf", + "to": "license-key-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -637,129 +613,117 @@ "default": "true" }, { - "from": "pserver", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "generic-vnf", + "to": "pnf", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "complex", - "label": "locatedIn", + "from": "generic-vnf", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "allotted-resource", - "to": "vlan", - "label": "isPartOf", + "from": "vnfc", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "zone", - "to": "complex", - "label": "existsIn", + "from": "generic-vnf", + "to": "vnf-image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "ctag-pool", - "to": "availability-zone", - "label": "supportsAvailabilityZone", + "from": "generic-vnf", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "owning-entity", - "to": "service-instance", - "label": "owns", + "from": "generic-vnf", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "vce", - "to": "port-group", - "label": "hasPortGroup", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "complex", - "label": "locatedIn", + "from": "lag-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair-set", - "to": "routing-instance", - "label": "hasRoutingInstance", + "from": "license", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "l-interface", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", + "from": "network-profile", "to": "generic-vnf", - "label": "isPartOf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -769,201 +733,189 @@ "default": "true" }, { - "from": "vnfc", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "service-instance", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "site-pair-set", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "vserver", - "label": "runsOnVserver", + "from": "vf-module", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "pserver", - "label": "bridgedTo", + "from": "pserver", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "oam-network", - "label": "has", + "from": "tenant", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "dvs-switch", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "service-instance", - "to": "allotted-resource", - "label": "has", + "from": "metadatum", + "to": "image", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "uses", + "from": "instance-group", + "to": "model", + "label": "org.onap.relationships.inventory.Targets", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "configuration", - "label": "uses", + "from": "vig-server", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "subnet", - "to": "host-route", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "lag-link", - "label": "usesLAGLink", + "from": "l3-interface-ipv4-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "generic-vnf", - "label": "bridgedTo", + "from": "l3-interface-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vce", - "to": "entitlement", - "label": "has", + "from": "l3-interface-ipv6-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "sriov-vf", - "label": "has", + "from": "l3-interface-ipv6-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "model", - "label": "isA", + "from": "l3-interface-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "group-assignment", - "to": "pserver", - "label": "has", + "from": "ctag-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vnfc", + "from": "l3-network", "to": "instance-group", - "label": "isMemberOf", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -973,21 +925,21 @@ "default": "true" }, { - "from": "service-instance", - "to": "cvlan-tag", - "label": "hasIPAGFacingVLAN", + "from": "l3-network", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "l3-network", + "to": "route-table-reference", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -997,155 +949,203 @@ "default": "true" }, { - "from": "line-of-business", - "to": "generic-vnf", - "label": "realizedBy", + "from": "l3-network", + "to": "vpn-binding", + "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" + }, + { + "from": "segmentation-assignment", + "to": "l3-network", + "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" }, { - "from": "l3-interface-ipv6-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "service-instance", + "to": "l3-network", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "pserver", - "label": "runsOnPserver", + "from": "subnet", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "instance-group", - "label": "isMemberOf", + "from": "lag-interface", + "to": "lag-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "lag-interface", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "lag-interface", + "to": "p-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "subnet", - "label": "hasSubnet", + "from": "l-interface", + "to": "lag-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "tenant", - "label": "belongsTo", + "from": "line-of-business", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "complex", - "label": "locatedIn", + "from": "l3-interface-ipv4-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "l3-interface-ipv6-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "l-interface", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", + "direction": "OUT", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "l3-network", - "label": "usesL3Network", + "from": "l-interface", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "l-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "availability-zone", - "to": "complex", - "label": "groupsResourcesIn", + "from": "sriov-vf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "vpn-binding", - "label": "belongsTo", + "from": "vlan", + "to": "l-interface", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "project", - "to": "service-instance", - "label": "created", + "from": "logical-link", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1153,9 +1153,9 @@ "default": "true" }, { - "from": "platform", + "from": "logical-link", "to": "generic-vnf", - "label": "uses", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1165,9 +1165,9 @@ "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "logical-link", + "to": "lag-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1177,45 +1177,45 @@ "default": "true" }, { - "from": "port-group", - "to": "cvlan-tag", - "label": "hasCTag", + "from": "logical-link", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "image", - "to": "metadatum", - "label": "hasMetaDatum", + "from": "logical-link", + "to": "pnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vnfc", - "to": "vip-ipv6-address-list", - "label": "uses", + "from": "logical-link", + "to": "pserver", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "oam-network", - "to": "complex", - "label": "definedFor", + "from": "logical-link", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1225,201 +1225,189 @@ "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "model-ver", + "to": "model", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "routing-instance", - "to": "site-pair", - "label": "hasSitePair", + "from": "constrained-element-set", + "to": "model-constraint", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpn-binding", - "to": "route-target", - "label": "has", + "from": "constrained-element-set", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "tunnel-xconnect", - "label": "has", + "from": "model-constraint", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "instance-group", - "label": "isMemberOf", + "from": "model-element", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "ipsec-configuration", - "to": "vig-server", - "label": "hasVigServer", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-constraint", - "to": "constrained-element-set", - "label": "uses", + "from": "named-query", + "to": "model", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "l-interface", - "label": "has", + "from": "named-query-element", + "to": "named-query", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "p-interface", - "label": "usesPInterface", + "from": "named-query-element", + "to": "model", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-constraint", - "label": "uses", + "from": "named-query-element", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "virtual-data-center", - "label": "contains", + "from": "property-constraint", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-element", - "to": "model-element", - "label": "connectsTo", + "from": "related-lookup", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, - { - "from": "tenant", - "to": "vserver", - "label": "owns", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", - "default": "true" - }, { "from": "l-interface", - "to": "vlan", - "label": "hasVlan", + "to": "newvce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "oam-network", + "to": "complex", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "instance-group", - "to": "model", - "label": "targets", + "from": "oam-network", + "to": "service-capability", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1430,34 +1418,46 @@ }, { "from": "service-instance", - "to": "zone", - "label": "locatedIn", + "to": "owning-entity", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "l-interface", + "to": "p-interface", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "p-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "configuration", - "to": "logical-link", - "label": "has", + "from": "p-interface", + "to": "physical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", @@ -1465,23 +1465,23 @@ "default": "true" }, { - "from": "configuration", - "to": "logical-link", - "label": "has", + "from": "sriov-pf", + "to": "p-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "pnf", - "label": "uses", + "from": "platform", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1489,93 +1489,117 @@ "default": "true" }, { - "from": "l3-network", - "to": "ctag-assignment", - "label": "hasCtagAssignment", + "from": "lag-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "instance-group", - "label": "isMemberOf", + "from": "p-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "vf-module", - "label": "isPartOf", + "from": "pnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "complex", - "to": "ctag-pool", - "label": "hasCtagPool", + "from": "pnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "constrained-element-set", - "to": "element-choice-set", - "label": "uses", + "from": "pnf", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "cvlan-tag", + "to": "port-group", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "complex", - "label": "locatedIn", + "from": "project", + "to": "service-instance", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "image", - "label": "hasImage", + "from": "lag-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "p-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "pserver", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", @@ -1585,23 +1609,23 @@ "default": "true" }, { - "from": "tenant", - "to": "l3-network", - "label": "usesL3Network", + "from": "pserver", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", + "from": "pserver", "to": "complex", - "label": "existsIn", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -1609,11 +1633,11 @@ "default": "true" }, { - "from": "logical-link", - "to": "cloud-region", - "label": "existsIn", + "from": "pserver", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1621,47 +1645,47 @@ "default": "true" }, { - "from": "sriov-vf", - "to": "sriov-pf", - "label": "uses", + "from": "site-pair", + "to": "routing-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "customer", - "to": "service-subscription", - "label": "subscribesTo", + "from": "allotted-resource", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "newvce", - "to": "l-interface", - "label": "hasLInterface", + "from": "metadatum", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", + "from": "service-instance", "to": "allotted-resource", - "label": "bindsTo", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1669,9 +1693,21 @@ "default": "true" }, { - "from": "allotted-resource", - "to": "l3-network", - "label": "isPartOf", + "from": "service-instance", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "service-instance", + "to": "connector", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1681,83 +1717,83 @@ "default": "true" }, { - "from": "p-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "service-instance", + "to": "ctag-assignment", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "availability-zone", - "label": "existsIn", + "from": "service-instance", + "to": "cvlan-tag", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "complex", - "label": "locatedIn", + "from": "service-instance", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "model-ver", - "to": "metadatum", - "label": "hasMetaData", + "from": "service-instance", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "volume", - "label": "hasVolume", + "from": "service-instance", + "to": "pnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "vip-ipv4-address-list", - "label": "hasIpAddress", + "from": "service-instance", + "to": "service-instance", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "zone", - "label": "isMemberOf", + "from": "service-instance", + "to": "vlan", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1765,11 +1801,11 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "service-instance", - "label": "hasInstance", + "from": "service-instance", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -1777,35 +1813,47 @@ "default": "true" }, { - "from": "cloud-region", - "to": "availability-zone", - "label": "has", + "from": "service-instance", + "to": "service-subscription", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "class-of-service", + "to": "site-pair", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair", - "to": "class-of-service", - "label": "hasClassOfService", + "from": "routing-instance", + "to": "site-pair-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "instance-group", - "label": "memberOf", + "from": "sriov-vf", + "to": "sriov-pf", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1813,141 +1861,129 @@ "default": "true" }, { - "from": "element-choice-set", - "to": "model-element", - "label": "has", + "from": "host-route", + "to": "subnet", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "network-policy", - "label": "uses", + "from": "service-subscription", + "to": "tenant", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnf-image", - "label": "usesVnfImage", + "from": "tenant", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "vserver", + "to": "tenant", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "l-interface", - "label": "hasLInterface", + "from": "entitlement", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license", - "label": "has", + "from": "license", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "zone", - "label": "isMemberOf", + "from": "port-group", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "service-instance", + "to": "vce", + "label": "org.onap.relationships.inventory.ComposedOf", + "direction": "OUT", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vnfc", - "to": "vip-ipv4-address-list", - "label": "uses", + "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": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "lag-interface", - "to": "logical-link", - "label": "uses", + "from": "vce", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "p-interface", - "to": "sriov-pf", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "l3-interface-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "volume-group", - "label": "uses", + "from": "vce", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", @@ -1957,57 +1993,45 @@ "default": "true" }, { - "from": "cloud-region", + "from": "vf-module", "to": "l3-network", - "label": "uses", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "group-assignment", - "label": "has", + "from": "vf-module", + "to": "vnfc", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "group-assignment", - "to": "tenant", - "label": "has", - "direction": "OUT", - "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "l-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "vf-module", + "to": "volume-group", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "virtual-data-center", - "to": "logical-link", - "label": "contains", + "from": "vip-ipv4-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -2017,21 +2041,21 @@ "default": "true" }, { - "from": "named-query-element", - "to": "named-query-element", - "label": "connectsTo", + "from": "vip-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "connector", - "label": "uses", + "from": "vip-ipv6-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -2041,23 +2065,23 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "vip-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pserver", - "to": "cloud-region", - "label": "locatedIn", + "from": "generic-vnf", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -2065,141 +2089,105 @@ "default": "true" }, { - "from": "vf-module", - "to": "l3-network", - "label": "uses", + "from": "logical-link", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "cloud-region", - "to": "snapshot", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "tenant", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "cloud-region", - "to": "image", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "model-ver", - "to": "model-element", - "label": "startsWith", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "l-interface", - "label": "hasLInterface", + "from": "l3-interface-ipv6-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "lag-interface", - "label": "has", + "from": "vlan", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "snapshot", - "label": "uses", + "from": "vlan", + "to": "multicast-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "property-constraint", - "label": "uses", + "from": "l3-interface-ipv4-address-list", + "to": "vnfc", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-subscription", - "to": "service-instance", - "label": "hasInstance", + "from": "l3-interface-ipv6-address-list", + "to": "vnfc", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "logical-link", - "label": "uses", + "from": "vnfc", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "tenant", - "to": "service-subscription", - "label": "relatedTo", + "from": "vnfc", + "to": "vip-ipv4-address-list", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -2209,11 +2197,11 @@ "default": "true" }, { - "from": "service-instance", - "to": "vlan", - "label": "dependsOn", + "from": "vnfc", + "to": "vip-ipv6-address-list", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -2221,71 +2209,71 @@ "default": "true" }, { - "from": "service-instance", - "to": "metadatum", - "label": "hasMetaData", + "from": "tenant", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "lag-link", - "label": "usesLAGLink", + "from": "volume-group", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { "from": "lag-interface", - "to": "l-interface", - "label": "hasLInterface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "named-query-element", - "label": "startsWith", + "from": "p-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "ctag-assignment", - "label": "uses", + "from": "vpls-pe", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "ipsec-configuration", - "label": "uses", + "from": "vpls-pe", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -2293,95 +2281,95 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "site-pair-set", - "label": "hasSitePairSet", + "from": "route-target", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model", - "to": "model-ver", - "label": "has", + "from": "l-interface", + "to": "vserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "metadatum", - "label": "hasMetaData", + "from": "vf-module", + "to": "vserver", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "network-profile", - "label": "hasNetworkProfile", + "from": "vnfc", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "volume-group", - "label": "uses", + "from": "vserver", + "to": "flavor", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "configuration", - "label": "has", + "from": "vserver", + "to": "image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "configuration", - "label": "has", + "from": "vserver", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "logical-link", - "to": "logical-link", - "label": "uses", + "from": "vserver", + "to": "snapshot", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -2389,64 +2377,40 @@ "default": "true" }, { - "from": "vpls-pe", - "to": "p-interface", - "label": "hasPinterface", + "from": "vserver", + "to": "volume", + "label": "tosca.relationships.AttachesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "${direction}", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license-key-resource", - "label": "uses", + "from": "metadatum", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "vpn-binding", - "label": "usesVpnBinding", + "from": "zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" - }, - { - "from": "complex", - "to": "l3-network", - "label": "usesL3Network", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "vlan", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" } ] } diff --git a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v12.json b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v12.json index ff813a48..4b33f0f2 100644 --- a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v12.json +++ b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v12.json @@ -61,2488 +61,2812 @@ "default": "true" }, { - "from": "vlan", - "to": "multicast-configuration", - "label": "uses", + "from": "allotted-resource", + "to": "allotted-resource", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vnfc", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "allotted-resource", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "allotted-resource", - "to": "l-interface", - "label": "uses", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "vf-module", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "vpn-binding", - "label": "uses", + "from": "allotted-resource", + "to": "l3-network", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "flavor", - "label": "hasFlavor", + "from": "allotted-resource", + "to": "l-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "l-interface", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "allotted-resource", "to": "network-policy", - "label": "uses", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "vnfc", - "label": "hosts", + "from": "allotted-resource", + "to": "vlan", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "cloud-region", - "to": "volume-group", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "vce", - "to": "service-instance", - "label": "hasServiceInstance", + "from": "allotted-resource", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", - "prevent-delete": "NONE", - "default": "true" + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "service-instance", - "label": "dependsOn", + "from": "tunnel-xconnect", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "flavor", - "label": "has", + "from": "availability-zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "pserver", - "label": "runsOnPserver", + "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": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vip-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "availability-zone", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "cloud-region", + "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" + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "pnf", - "label": "bridgedTo", + "from": "cloud-region", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "virtual-data-center", - "to": "generic-vnf", - "label": "hasVNF", + "from": "cloud-region", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pnf", - "to": "p-interface", - "label": "hasPinterface", + "from": "dvs-switch", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "vip-ipv4-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "flavor", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "pnf", - "label": "hostedOn", + "from": "group-assignment", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "p-interface", - "to": "physical-link", - "label": "usesPhysicalLink", + "from": "image", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "model-element", - "to": "model-ver", - "label": "isA", + "from": "oam-network", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pnf", - "to": "complex", - "label": "locatedIn", + "from": "snapshot", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-interface-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "tenant", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "oam-network", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "vip-ipv4-address-list", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pserver", - "to": "zone", - "label": "isMemberOf", + "from": "vip-ipv6-address-list", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "segmentation-assignment", - "label": "has", + "from": "volume-group", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "metadatum", - "label": "owns", + "from": "complex", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vce", - "to": "license", - "label": "has", + "from": "ctag-pool", + "to": "complex", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query-element", - "to": "related-lookup", - "label": "uses", + "from": "configuration", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pserver", - "to": "p-interface", - "label": "hasPinterface", + "from": "configuration", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vip-ipv6-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "metadatum", + "to": "configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "vserver", - "label": "runsOnVserver", + "from": "connector", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vpls-pe", - "to": "lag-interface", - "label": "hasLAGinterface", + "from": "metadatum", + "to": "connector", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "vnfc", - "label": "uses", + "from": "element-choice-set", + "to": "constrained-element-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "service-instance", - "label": "hasInstance", + "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": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" + }, + { + "from": "service-subscription", + "to": "customer", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query", - "to": "model", - "label": "relatedTo", + "from": "dvs-switch", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vf-module", - "to": "vnfc", - "label": "uses", + "from": "model-element", + "to": "element-choice-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "${direction}", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "entitlement", - "label": "has", + "from": "entitlement", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vip-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "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": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "availability-zone", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "generic-vnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "l3-interface-ipv4-address-list", - "to": "l3-network", - "label": "isMemberOf", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "vip-ipv6-address-list", - "label": "hasIpAddress", + "from": "generic-vnf", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "route-table-reference", - "label": "uses", + "from": "generic-vnf", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "model-element", - "to": "constrained-element-set", - "label": "connectsTo", + "from": "generic-vnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "allotted-resource", - "label": "uses", + "from": "generic-vnf", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "dvs-switch", - "to": "availability-zone", - "label": "existsIn", + "from": "generic-vnf", + "to": "l3-network", + "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" - }, - { - "from": "pserver", - "to": "lag-interface", - "label": "hasLAGInterface", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vpls-pe", - "to": "complex", - "label": "locatedIn", + "from": "generic-vnf", + "to": "license-key-resource", + "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" + "default": "true", + "description":"" }, { - "from": "allotted-resource", - "to": "vlan", - "label": "isPartOf", + "from": "generic-vnf", + "to": "pnf", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "zone", - "to": "complex", - "label": "existsIn", + "from": "generic-vnf", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "ctag-pool", - "to": "availability-zone", - "label": "supportsAvailabilityZone", + "from": "vnfc", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "generic-vnf", + "to": "vnf-image", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "owning-entity", - "to": "service-instance", - "label": "owns", + "from": "generic-vnf", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vce", - "to": "port-group", - "label": "hasPortGroup", + "from": "generic-vnf", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vce", - "to": "complex", - "label": "locatedIn", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "from": "lag-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "site-pair-set", - "to": "routing-instance", - "label": "hasRoutingInstance", + "from": "license", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "l-interface", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "allotted-resource", + "from": "network-profile", "to": "generic-vnf", - "label": "isPartOf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vnfc", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "service-instance", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "operational-environment", - "to": "operational-environment", - "label": "managedBy", - "direction": "OUT", - "multiplicity": "One2One", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vce", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "site-pair-set", + "to": "generic-vnf", + "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" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "vce", - "to": "vserver", - "label": "runsOnVserver", + "from": "vf-module", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "pserver", - "label": "bridgedTo", + "from": "pserver", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "cloud-region", - "to": "oam-network", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", "prevent-delete": "${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "dvs-switch", - "label": "has", + "from": "tenant", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "has", + "from": "metadatum", + "to": "image", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "uses", + "from": "instance-group", + "to": "model", + "label": "org.onap.relationships.inventory.Targets", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "configuration", - "label": "uses", + "from": "vig-server", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "subnet", - "to": "host-route", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "lag-interface", - "to": "lag-link", - "label": "usesLAGLink", + "from": "l3-interface-ipv4-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "generic-vnf", - "label": "bridgedTo", + "from": "l3-interface-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "vce", - "to": "entitlement", - "label": "has", + "from": "l3-interface-ipv6-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "sriov-vf", - "label": "has", + "from": "l3-interface-ipv6-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query-element", - "to": "model", - "label": "isA", + "from": "l3-interface-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "group-assignment", - "to": "pserver", - "label": "has", + "from": "ctag-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "vnfc", + "from": "l3-network", "to": "instance-group", - "label": "isMemberOf", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "cvlan-tag", - "label": "hasIPAGFacingVLAN", + "from": "l3-network", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "l3-network", + "to": "route-table-reference", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "line-of-business", - "to": "generic-vnf", - "label": "realizedBy", + "from": "l3-network", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "l3-interface-ipv6-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "segmentation-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "pserver", - "label": "runsOnPserver", + "from": "service-instance", + "to": "l3-network", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "operational-environment", - "to": "operational-environment", - "label": "managedBy", + "from": "subnet", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "allotted-resource", - "to": "instance-group", - "label": "isMemberOf", + "from": "lag-interface", + "to": "lag-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "lag-interface", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "l3-interface-ipv4-address-list", - "to": "instance-group", - "label": "isMemberOf", + "from": "lag-interface", + "to": "p-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "subnet", - "label": "hasSubnet", + "from": "l-interface", + "to": "lag-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "volume-group", - "to": "tenant", - "label": "belongsTo", + "from": "line-of-business", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "complex", - "label": "locatedIn", + "from": "l3-interface-ipv4-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "l3-interface-ipv6-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "l-interface", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", + "direction": "OUT", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "l3-network", - "label": "usesL3Network", + "from": "l-interface", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "l-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "availability-zone", - "to": "complex", - "label": "groupsResourcesIn", + "from": "logical-link", + "to": "l-interface", + "label": "org.onap.relationships.inventory.Source", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "false", + "description":"" }, { - "from": "allotted-resource", - "to": "vpn-binding", - "label": "belongsTo", + "from": "logical-link", + "to": "l-interface", + "label": "org.onap.relationships.inventory.Destination", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "false", + "description":"" + }, + { + "from": "sriov-vf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "project", - "to": "service-instance", - "label": "created", + "from": "vlan", + "to": "l-interface", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "logical-link", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", + "direction": "OUT", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "platform", + "from": "logical-link", "to": "generic-vnf", - "label": "uses", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-interface-ipv6-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "logical-link", + "to": "lag-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "port-group", - "to": "cvlan-tag", - "label": "hasCTag", + "from": "logical-link", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "image", - "to": "metadatum", - "label": "hasMetaDatum", + "from": "logical-link", + "to": "pnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vnfc", - "to": "vip-ipv6-address-list", - "label": "uses", + "from": "logical-link", + "to": "pserver", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "oam-network", - "to": "complex", - "label": "definedFor", + "from": "logical-link", + "to": "vpn-binding", + "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" + "default": "true", + "description":"" }, { - "from": "vlan", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "model-ver", + "to": "model", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "routing-instance", - "to": "site-pair", - "label": "hasSitePair", + "from": "constrained-element-set", + "to": "model-constraint", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vpn-binding", - "to": "route-target", - "label": "has", + "from": "constrained-element-set", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "allotted-resource", - "to": "tunnel-xconnect", - "label": "has", + "from": "model-constraint", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "instance-group", - "label": "isMemberOf", + "from": "model-element", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", + "direction": "OUT", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "ipsec-configuration", - "to": "vig-server", - "label": "hasVigServer", + "from": "metadatum", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "model-constraint", - "to": "constrained-element-set", - "label": "uses", + "from": "named-query", + "to": "model", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "l-interface", - "label": "has", + "from": "named-query-element", + "to": "named-query", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "lag-interface", - "to": "p-interface", - "label": "usesPInterface", + "from": "named-query-element", + "to": "model", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" + }, + { + "from": "named-query-element", + "to": "named-query-element", + "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" + "default": "true", + "description":"" }, { - "from": "model-element", - "to": "model-constraint", - "label": "uses", + "from": "property-constraint", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "connector", - "to": "virtual-data-center", - "label": "contains", + "from": "related-lookup", + "to": "named-query-element", + "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": "l-interface", + "to": "newvce", + "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": "oam-network", + "to": "complex", + "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": "oam-network", + "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": "operational-environment", + "to": "operational-environment", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "model-element", - "to": "model-element", - "label": "connectsTo", + "from": "service-instance", + "to": "owning-entity", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "tenant", - "to": "vserver", - "label": "owns", + "from": "l-interface", + "to": "p-interface", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "vlan", - "label": "hasVlan", + "from": "p-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "p-interface", + "to": "physical-link", + "label": "tosca.relationships.network.LinksTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vpls-pe", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "sriov-pf", + "to": "p-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "instance-group", - "to": "model", - "label": "targets", + "from": "platform", + "to": "generic-vnf", + "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" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "zone", - "label": "locatedIn", + "from": "lag-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "p-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "pnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { "from": "pnf", "to": "instance-group", - "label": "isMemberOf", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "logical-link", - "label": "has", + "from": "pnf", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "logical-link", - "label": "has", + "from": "cvlan-tag", + "to": "port-group", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "pnf", - "label": "uses", + "from": "project", + "to": "service-instance", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "ctag-assignment", - "label": "hasCtagAssignment", + "from": "lag-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "instance-group", - "label": "isMemberOf", + "from": "p-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "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": "NONE", - "prevent-delete": "NONE", - "default": "true" + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "vf-module", - "label": "isPartOf", + "from": "pserver", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "complex", - "to": "ctag-pool", - "label": "hasCtagPool", + "from": "pserver", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" + }, + { + "from": "pserver", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" + }, + { + "from": "site-pair", + "to": "routing-instance", + "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" + "default": "true", + "description":"" }, { - "from": "constrained-element-set", - "to": "element-choice-set", - "label": "uses", + "from": "allotted-resource", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "p-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "metadatum", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "complex", - "label": "locatedIn", + "from": "service-instance", + "to": "allotted-resource", + "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" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "image", - "label": "hasImage", + "from": "service-instance", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "tenant", - "to": "l3-network", - "label": "usesL3Network", + "from": "service-instance", + "to": "connector", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "volume-group", - "to": "complex", - "label": "existsIn", + "from": "service-instance", + "to": "ctag-assignment", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "cloud-region", - "label": "existsIn", + "from": "service-instance", + "to": "cvlan-tag", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "sriov-vf", - "to": "sriov-pf", - "label": "uses", + "from": "service-instance", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "customer", - "to": "service-subscription", - "label": "subscribesTo", + "from": "service-instance", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "newvce", - "to": "l-interface", - "label": "hasLInterface", + "from": "service-instance", + "to": "pnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "allotted-resource", - "to": "allotted-resource", - "label": "bindsTo", + "from": "service-instance", + "to": "service-instance", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "allotted-resource", - "to": "l3-network", - "label": "isPartOf", + "from": "service-instance", + "to": "vlan", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "p-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "service-instance", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pserver", - "to": "availability-zone", - "label": "existsIn", + "from": "service-instance", + "to": "service-subscription", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "pserver", - "to": "complex", - "label": "locatedIn", + "from": "class-of-service", + "to": "site-pair", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", - "default": "true" + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "model-ver", - "to": "metadatum", - "label": "hasMetaData", + "from": "routing-instance", + "to": "site-pair-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "volume", - "label": "hasVolume", + "from": "sriov-vf", + "to": "sriov-pf", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "vip-ipv4-address-list", - "label": "hasIpAddress", + "from": "host-route", + "to": "subnet", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "zone", - "label": "isMemberOf", + "from": "service-subscription", + "to": "tenant", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "service-instance", - "label": "hasInstance", + "from": "tenant", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "availability-zone", - "label": "has", + "from": "vserver", + "to": "tenant", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "site-pair", - "to": "class-of-service", - "label": "hasClassOfService", + "from": "entitlement", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "instance-group", - "label": "memberOf", + "from": "license", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "element-choice-set", - "to": "model-element", - "label": "has", + "from": "port-group", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "network-policy", - "label": "uses", + "from": "service-instance", + "to": "vce", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "vnf-image", - "label": "usesVnfImage", + "from": "vce", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" + }, + { + "from": "vce", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", + "direction": "OUT", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vlan", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "vce", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "l-interface", - "label": "hasLInterface", + "from": "vf-module", + "to": "l3-network", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "license", - "label": "has", + "from": "vf-module", + "to": "vnfc", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "${direction}", + "default": "true", + "description":"" }, { - "from": "pnf", - "to": "zone", - "label": "isMemberOf", + "from": "vf-module", + "to": "volume-group", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vnfc", - "to": "vip-ipv4-address-list", - "label": "uses", + "from": "vip-ipv4-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "lag-interface", - "to": "logical-link", - "label": "uses", + "from": "vip-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "p-interface", - "to": "sriov-pf", - "label": "has", + "from": "vip-ipv6-address-list", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l3-interface-ipv6-address-list", + "from": "vip-ipv6-address-list", "to": "subnet", - "label": "isMemberOf", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", - "default": "true" + "default": "true", + "description":"" }, { "from": "generic-vnf", - "to": "volume-group", - "label": "uses", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "l3-network", - "label": "uses", + "from": "logical-link", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "cloud-region", - "to": "group-assignment", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "group-assignment", - "to": "tenant", - "label": "has", + "from": "l3-interface-ipv6-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l-interface", + "from": "vlan", "to": "logical-link", - "label": "usesLogicalLink", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "logical-link", - "label": "sourceLInterface", + "from": "vlan", + "to": "multicast-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "false" + "default": "true", + "description":"" }, { - "from": "l-interface", - "to": "logical-link", - "label": "targetLInterface", + "from": "l3-interface-ipv4-address-list", + "to": "vnfc", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "false" + "default": "true", + "description":"" }, { - "from": "virtual-data-center", - "to": "logical-link", - "label": "contains", + "from": "l3-interface-ipv6-address-list", + "to": "vnfc", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query-element", - "to": "named-query-element", - "label": "connectsTo", + "from": "vnfc", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "connector", - "label": "uses", + "from": "vnfc", + "to": "vip-ipv4-address-list", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "vnfc", + "to": "vip-ipv6-address-list", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pserver", - "to": "cloud-region", - "label": "locatedIn", + "from": "tenant", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vf-module", - "to": "l3-network", - "label": "uses", + "from": "volume-group", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "cloud-region", - "to": "snapshot", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "cloud-region", - "to": "tenant", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "cloud-region", - "to": "image", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "model-ver", - "to": "model-element", - "label": "startsWith", + "from": "lag-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "l-interface", - "label": "hasLInterface", + "from": "p-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "pnf", - "to": "lag-interface", - "label": "has", + "from": "vpls-pe", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "vserver", - "to": "snapshot", - "label": "uses", + "from": "vpls-pe", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query-element", - "to": "property-constraint", - "label": "uses", + "from": "route-target", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-subscription", - "to": "service-instance", - "label": "hasInstance", + "from": "l-interface", + "to": "vserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "logical-link", - "label": "uses", + "from": "vf-module", + "to": "vserver", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "tenant", - "to": "service-subscription", - "label": "relatedTo", + "from": "vnfc", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "vlan", - "label": "dependsOn", + "from": "vserver", + "to": "flavor", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "metadatum", - "label": "hasMetaData", + "from": "vserver", + "to": "image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "lag-link", - "label": "usesLAGLink", + "from": "vserver", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "lag-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "vserver", + "to": "snapshot", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "named-query", - "to": "named-query-element", - "label": "startsWith", + "from": "vserver", + "to": "volume", + "label": "tosca.relationships.AttachesTo", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "${direction}", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "ctag-assignment", - "label": "uses", + "from": "zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" + "prevent-delete": "!${direction}", + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "ipsec-configuration", - "label": "uses", + "from": "allotted-resource", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "Many2One", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "generic-vnf", - "to": "site-pair-set", - "label": "hasSitePairSet", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "Many2One", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "model", + "from": "l3-network", "to": "model-ver", - "label": "has", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "Many2One", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "connector", - "to": "metadatum", - "label": "hasMetaData", + "from": "logical-link", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "Many2One", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "network-profile", - "label": "hasNetworkProfile", + "from": "service-instance", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "Many2One", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "vf-module", - "to": "volume-group", - "label": "uses", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "Many2One", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "service-instance", - "to": "configuration", - "label": "has", + "from": "configuration", + "to": "l-interface", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "logical-link", - "to": "logical-link", - "label": "uses", + "from": "configuration", + "to": "pnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "vpls-pe", - "to": "p-interface", - "label": "hasPinterface", + "from": "forwarder", + "to": "forwarding-path", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "generic-vnf", - "to": "license-key-resource", - "label": "uses", + "from": "forwarding-path", + "to": "service-instance", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" + "prevent-delete": "NONE", + "default": "true", + "description":"" }, { - "from": "l3-network", - "to": "vpn-binding", - "label": "usesVpnBinding", + "from": "forwarder", + "to": "l-interface", + "label": "org.onap.relationships.inventory.ForwardsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "complex", - "to": "l3-network", - "label": "usesL3Network", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "vlan", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "l-interface", - "label": "has", + "from": "forwarder", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "configuration", - "to": "pnf", - "label": "uses", + "from": "forwarding-path", + "to": "configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { "from": "forwarder", - "to": "p-interface", - "label": "forwardsTo", + "to": "lag-interface", + "label": "org.onap.relationships.inventory.ForwardsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "forwarder", - "to": "l-interface", - "label": "forwardsTo", + "from": "evc", + "to": "configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "forwarder", - "to": "forwarding-path", - "label": "belongsTo", + "from": "forwarder-evc", + "to": "configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2ONE", "contains-other-v": "!${direction}", "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" }, { - "from": "forwarding-path", - "to": "service-instance", - "label": "implements", + "from": "forwarder", + "to": "p-interface", + "label": "org.onap.relationships.inventory.ForwardsTo", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description":"" } ] } diff --git a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v8.json b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v8.json index 9997468f..0e9eebb0 100644 --- a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v8.json +++ b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v8.json @@ -1,189 +1,165 @@ { "rules": [ { - "from": "ipsec-configuration", - "to": "vig-server", - "label": "hasVigServer", + "from": "availability-zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vlan", - "to": "multicast-configuration", - "label": "uses", + "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": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "lag-interface", - "label": "hasLAGInterface", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-constraint", - "to": "constrained-element-set", - "label": "uses", + "from": "availability-zone", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vf-module", - "label": "has", + "from": "cloud-region", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "lag-interface", - "to": "p-interface", - "label": "usesPInterface", + "from": "cloud-region", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-element", - "to": "model-constraint", - "label": "uses", + "from": "dvs-switch", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "connector", - "to": "virtual-data-center", - "label": "contains", + "from": "flavor", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-element", - "label": "connectsTo", + "from": "group-assignment", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "tenant", - "to": "vserver", - "label": "owns", + "from": "image", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "flavor", - "label": "hasFlavor", + "from": "oam-network", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "vlan", - "label": "hasVlan", + "from": "snapshot", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "tenant", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "model", - "to": "metadatum", - "label": "hasMetaData", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vpls-pe", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "volume-group", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "vnfc", - "label": "hosts", + "from": "complex", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -193,179 +169,155 @@ "default": "true" }, { - "from": "cloud-region", - "to": "volume-group", - "label": "has", + "from": "ctag-pool", + "to": "complex", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "l3-network", - "to": "ctag-assignment", - "label": "hasCtagAssignment", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "service-instance", - "label": "hasServiceInstance", + "from": "connector", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "service-instance", - "label": "dependsOn", + "from": "metadatum", + "to": "connector", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "flavor", - "label": "has", + "from": "element-choice-set", + "to": "constrained-element-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "pserver", - "label": "runsOnPserver", + "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": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "logical-link", - "to": "pnf", - "label": "bridgedTo", + "from": "service-subscription", + "to": "customer", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "virtual-data-center", - "to": "generic-vnf", - "label": "hasVNF", + "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": "!${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pnf", - "to": "p-interface", - "label": "hasPinterface", + "from": "model-element", + "to": "element-choice-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "vf-module", - "label": "isPartOf", + "from": "generic-vnf", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "complex", - "to": "ctag-pool", - "label": "hasCtagPool", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "constrained-element-set", - "to": "element-choice-set", - "label": "uses", + "from": "generic-vnf", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "generic-vnf", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "physical-link", - "label": "usesPhysicalLink", + "from": "generic-vnf", + "to": "license-key-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "image", - "label": "hasImage", + "from": "generic-vnf", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -373,35 +325,23 @@ "default": "true" }, { - "from": "pnf", - "to": "complex", - "label": "locatedIn", + "from": "vnfc", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "tenant", - "to": "l3-network", - "label": "usesL3Network", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "generic-vnf", + "to": "vnf-image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -409,225 +349,213 @@ "default": "true" }, { - "from": "volume-group", - "to": "complex", - "label": "existsIn", + "from": "generic-vnf", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "oam-network", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "generic-vnf", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "customer", - "to": "service-subscription", - "label": "subscribesTo", + "from": "lag-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "segmentation-assignment", - "label": "has", + "from": "l-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "related-lookup", - "label": "uses", + "from": "network-profile", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "p-interface", - "label": "hasPinterface", + "from": "service-instance", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "newvce", - "to": "l-interface", - "label": "hasLInterface", + "from": "site-pair-set", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "p-interface", - "to": "logical-link", - "label": "usesLogicalLink", - "direction": "OUT", - "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vserver", - "label": "runsOnVserver", + "from": "vf-module", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { "from": "pserver", - "to": "availability-zone", - "label": "existsIn", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "vpls-pe", - "to": "lag-interface", - "label": "hasLAGinterface", + "from": "tenant", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnfc", - "label": "uses", + "from": "metadatum", + "to": "image", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "service-instance", - "label": "hasInstance", + "from": "vig-server", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "model", - "label": "relatedTo", + "from": "l3-interface-ipv4-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "vnfc", - "label": "uses", + "from": "l3-interface-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pserver", - "to": "complex", - "label": "locatedIn", + "from": "l3-interface-ipv6-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "availability-zone", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "l3-interface-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "volume", - "label": "hasVolume", + "from": "ctag-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "l3-network", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -637,275 +565,299 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "service-instance", - "label": "hasInstance", + "from": "l3-network", + "to": "route-table-reference", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "l3-network", - "to": "route-table-reference", - "label": "uses", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "constrained-element-set", - "label": "connectsTo", + "from": "segmentation-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "dvs-switch", - "to": "availability-zone", - "label": "existsIn", + "from": "service-instance", + "to": "l3-network", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "subnet", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "availability-zone", - "label": "has", + "from": "lag-interface", + "to": "lag-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "complex", - "label": "locatedIn", + "from": "lag-interface", + "to": "p-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair", - "to": "class-of-service", - "label": "hasClassOfService", + "from": "l-interface", + "to": "lag-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "element-choice-set", - "to": "model-element", - "label": "has", + "from": "l3-interface-ipv4-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "ctag-pool", - "to": "availability-zone", - "label": "supportsAvailabilityZone", + "from": "l3-interface-ipv6-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "network-policy", - "label": "uses", + "from": "l-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "port-group", - "label": "hasPortGroup", + "from": "sriov-vf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "vlan", + "to": "l-interface", + "label": "tosca.relationships.network.LinksTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "logical-link", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "complex", - "label": "locatedIn", + "from": "logical-link", + "to": "lag-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnf-image", - "label": "usesVnfImage", + "from": "logical-link", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "site-pair-set", - "to": "routing-instance", - "label": "hasRoutingInstance", + "from": "logical-link", + "to": "pnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "logical-link", + "to": "pserver", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "l-interface", - "label": "hasLInterface", + "from": "constrained-element-set", + "to": "model-constraint", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "constrained-element-set", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "model-constraint", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "vserver", - "label": "runsOnVserver", + "from": "model-element", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "named-query", + "to": "model", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "volume-group", - "label": "uses", + "from": "named-query-element", + "to": "named-query", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "pserver", - "label": "bridgedTo", + "from": "named-query-element", + "to": "model", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -913,237 +865,249 @@ "default": "true" }, { - "from": "cloud-region", - "to": "oam-network", - "label": "has", + "from": "named-query-element", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "dvs-switch", - "label": "has", + "from": "property-constraint", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "l3-network", - "label": "uses", + "from": "related-lookup", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "group-assignment", - "label": "has", + "from": "l-interface", + "to": "newvce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "group-assignment", - "to": "tenant", - "label": "has", + "from": "oam-network", + "to": "complex", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "oam-network", + "to": "service-capability", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "l-interface", + "to": "p-interface", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "virtual-data-center", + "from": "p-interface", "to": "logical-link", - "label": "contains", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "named-query-element", - "label": "connectsTo", + "from": "p-interface", + "to": "physical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "connector", - "label": "uses", + "from": "lag-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "lag-link", - "label": "usesLAGLink", + "from": "p-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "cloud-region", - "label": "locatedIn", + "from": "pnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "logical-link", - "to": "generic-vnf", - "label": "bridgedTo", + "from": "cvlan-tag", + "to": "port-group", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "l3-network", - "label": "uses", + "from": "lag-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "sriov-vf", - "label": "has", + "from": "p-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "model", - "label": "isA", + "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": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "group-assignment", - "to": "pserver", - "label": "has", + "from": "pserver", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "snapshot", - "label": "has", + "from": "pserver", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "tenant", - "label": "has", + "from": "site-pair", + "to": "routing-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "image", - "label": "has", + "from": "metadatum", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { "from": "service-instance", - "to": "cvlan-tag", - "label": "hasIPAGFacingVLAN", + "to": "connector", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1153,93 +1117,105 @@ "default": "true" }, { - "from": "vserver", - "to": "l-interface", - "label": "hasLInterface", + "from": "service-instance", + "to": "cvlan-tag", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "lag-interface", - "label": "has", + "from": "service-instance", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "snapshot", - "label": "uses", + "from": "service-instance", + "to": "service-instance", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "ONE2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-element", - "to": "model", - "label": "isA", + "from": "service-instance", + "to": "vlan", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "property-constraint", - "label": "uses", + "from": "service-instance", + "to": "service-subscription", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "class-of-service", + "to": "site-pair", + "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" }, { - "from": "service-subscription", - "to": "service-instance", - "label": "hasInstance", + "from": "routing-instance", + "to": "site-pair-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "logical-link", - "label": "uses", + "from": "service-subscription", + "to": "tenant", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "tenant", - "to": "service-subscription", - "label": "relatedTo", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1250,44 +1226,56 @@ }, { "from": "vserver", - "to": "pserver", - "label": "runsOnPserver", + "to": "tenant", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, + { + "from": "port-group", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, { "from": "service-instance", - "to": "vlan", - "label": "dependsOn", + "to": "vce", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "metadatum", - "label": "hasMetaData", + "from": "vce", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "vce", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1297,11 +1285,11 @@ "default": "true" }, { - "from": "logical-link", - "to": "lag-link", - "label": "usesLAGLink", + "from": "vce", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -1309,45 +1297,45 @@ "default": "true" }, { - "from": "l3-network", - "to": "subnet", - "label": "hasSubnet", + "from": "vf-module", + "to": "l3-network", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "tenant", - "label": "belongsTo", + "from": "vf-module", + "to": "vnfc", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "complex", - "label": "locatedIn", + "from": "vf-module", + "to": "volume-group", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { "from": "generic-vnf", - "to": "l3-network", - "label": "usesL3Network", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1357,57 +1345,57 @@ "default": "true" }, { - "from": "availability-zone", - "to": "complex", - "label": "groupsResourcesIn", + "from": "logical-link", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "l3-interface-ipv4-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "named-query-element", - "label": "startsWith", + "from": "l3-interface-ipv6-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "ipsec-configuration", - "label": "uses", + "from": "vlan", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "site-pair-set", - "label": "hasSitePairSet", + "from": "vlan", + "to": "multicast-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1417,191 +1405,203 @@ "default": "true" }, { - "from": "model", - "to": "model-element", - "label": "startsWith", + "from": "tenant", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "metadatum", - "label": "hasMetaData", + "from": "volume-group", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "network-profile", - "label": "hasNetworkProfile", + "from": "lag-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "volume-group", - "label": "uses", + "from": "p-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "logical-link", - "label": "uses", + "from": "vpls-pe", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "vpls-pe", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "port-group", - "to": "cvlan-tag", - "label": "hasCTag", + "from": "l-interface", + "to": "vserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "p-interface", - "label": "hasPinterface", + "from": "vf-module", + "to": "vserver", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "image", - "to": "metadatum", - "label": "hasMetaDatum", + "from": "vnfc", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license-key-resource", - "label": "uses", + "from": "vserver", + "to": "flavor", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-network", - "to": "vpn-binding", - "label": "usesVpnBinding", + "from": "vserver", + "to": "image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "complex", - "to": "l3-network", - "label": "usesL3Network", + "from": "model-element", + "to": "model", + "label": "isA", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "oam-network", - "to": "complex", - "label": "definedFor", + "from": "model", + "to": "model-element", + "label": "startsWith", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "${direction}", + "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "metadatum", + "to": "model", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "routing-instance", - "to": "site-pair", - "label": "hasSitePair", + "from": "vserver", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "vserver", + "to": "snapshot", + "label": "org.onap.relationships.inventory.Uses", + "direction": "OUT", + "multiplicity": "ONE2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "vserver", + "to": "volume", + "label": "tosca.relationships.AttachesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "${direction}", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", diff --git a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v9.json b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v9.json index d579d9a3..d1184e22 100644 --- a/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v9.json +++ b/aai-core/src/main/resources/dbedgerules/DbEdgeRules_v9.json @@ -1,21 +1,21 @@ { "rules": [ { - "from": "ipsec-configuration", - "to": "vig-server", - "label": "hasVigServer", + "from": "allotted-resource", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "multicast-configuration", - "label": "uses", + "from": "allotted-resource", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -25,69 +25,93 @@ "default": "true" }, { - "from": "generic-vnf", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "allotted-resource", + "to": "l3-network", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-constraint", - "to": "constrained-element-set", - "label": "uses", + "from": "allotted-resource", + "to": "vlan", + "label": "org.onap.relationships.inventory.PartOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vf-module", - "label": "has", + "from": "tunnel-xconnect", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "lag-interface", - "to": "p-interface", - "label": "usesPInterface", + "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" + }, + { + "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": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "model-element", - "to": "model-constraint", - "label": "uses", + "from": "availability-zone", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "virtual-data-center", - "label": "contains", + "from": "cloud-region", + "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" + }, + { + "from": "cloud-region", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -97,143 +121,143 @@ "default": "true" }, { - "from": "model-element", - "to": "model-element", - "label": "connectsTo", + "from": "cloud-region", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "vpn-binding", - "label": "uses", + "from": "dvs-switch", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "tenant", - "to": "vserver", - "label": "owns", + "from": "flavor", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "flavor", - "label": "hasFlavor", + "from": "group-assignment", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "vlan", - "label": "hasVlan", + "from": "image", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", + "from": "oam-network", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vpls-pe", - "to": "ctag-pool", - "label": "usesCtagPool", + "from": "snapshot", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "vnfc", - "label": "hosts", + "from": "tenant", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "instance-group", - "to": "model", - "label": "targets", + "from": "volume-group", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "pnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "complex", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "volume-group", - "label": "has", + "from": "ctag-pool", + "to": "complex", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "pnf", - "label": "uses", + "from": "connector", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -241,69 +265,93 @@ "default": "true" }, { - "from": "l3-network", - "to": "ctag-assignment", - "label": "hasCtagAssignment", + "from": "metadatum", + "to": "connector", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "service-instance", - "label": "hasServiceInstance", + "from": "element-choice-set", + "to": "constrained-element-set", + "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" + }, + { + "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": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", + "default": "true" + }, + { + "from": "service-subscription", + "to": "customer", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "service-instance", - "label": "dependsOn", + "from": "dvs-switch", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "flavor", - "label": "has", + "from": "model-element", + "to": "element-choice-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "instance-group", - "label": "isMemberOf", + "from": "entitlement", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "generic-vnf", - "to": "pserver", - "label": "runsOnPserver", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -313,9 +361,9 @@ "default": "true" }, { - "from": "logical-link", - "to": "pnf", - "label": "bridgedTo", + "from": "generic-vnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -325,35 +373,23 @@ "default": "true" }, { - "from": "virtual-data-center", - "to": "generic-vnf", - "label": "hasVNF", + "from": "generic-vnf", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "p-interface", - "label": "hasPinterface", + "from": "generic-vnf", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "vserver", - "to": "vf-module", - "label": "isPartOf", - "direction": "OUT", - "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -361,129 +397,117 @@ "default": "true" }, { - "from": "complex", - "to": "ctag-pool", - "label": "hasCtagPool", + "from": "generic-vnf", + "to": "license-key-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "constrained-element-set", - "to": "element-choice-set", - "label": "uses", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "p-interface", - "to": "l-interface", - "label": "hasLInterface", + "from": "generic-vnf", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "p-interface", - "to": "physical-link", - "label": "usesPhysicalLink", + "from": "vnfc", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-element", - "to": "model-ver", - "label": "isA", + "from": "generic-vnf", + "to": "vnf-image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "vserver", - "to": "image", - "label": "hasImage", + "from": "generic-vnf", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "complex", - "label": "locatedIn", + "from": "generic-vnf", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "tenant", - "to": "l3-network", - "label": "usesL3Network", + "from": "lag-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-interface-ipv4-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "license", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "complex", - "label": "existsIn", + "from": "l-interface", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "cloud-region", - "label": "existsIn", + "from": "network-profile", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -493,23 +517,23 @@ "default": "true" }, { - "from": "oam-network", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "service-instance", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "zone", - "label": "isMemberOf", + "from": "site-pair-set", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -517,107 +541,107 @@ "default": "true" }, { - "from": "customer", - "to": "service-subscription", - "label": "subscribesTo", + "from": "vf-module", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "segmentation-assignment", - "label": "has", + "from": "pserver", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "vce", - "to": "license", - "label": "has", + "from": "tenant", + "to": "group-assignment", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "related-lookup", - "label": "uses", + "from": "metadatum", + "to": "image", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "p-interface", - "label": "hasPinterface", + "from": "instance-group", + "to": "model", + "label": "org.onap.relationships.inventory.Targets", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "newvce", - "to": "l-interface", - "label": "hasLInterface", + "from": "vig-server", + "to": "ipsec-configuration", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", + "from": "l3-interface-ipv4-address-list", "to": "l3-network", - "label": "isPartOf", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "p-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "l3-interface-ipv4-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "vserver", - "label": "runsOnVserver", + "from": "l3-interface-ipv6-address-list", + "to": "l3-network", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -625,11 +649,11 @@ "default": "true" }, { - "from": "pserver", - "to": "availability-zone", - "label": "existsIn", + "from": "l3-interface-ipv6-address-list", + "to": "subnet", + "label": "org.onap.relationships.inventory.network.MemberOf", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -637,47 +661,47 @@ "default": "true" }, { - "from": "vpls-pe", - "to": "lag-interface", - "label": "hasLAGinterface", + "from": "ctag-assignment", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnfc", - "label": "uses", + "from": "l3-network", + "to": "network-policy", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { "from": "l3-network", - "to": "service-instance", - "label": "hasInstance", + "to": "route-table-reference", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "model", - "label": "relatedTo", + "from": "l3-network", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -685,189 +709,189 @@ "default": "true" }, { - "from": "vf-module", - "to": "vnfc", - "label": "uses", + "from": "segmentation-assignment", + "to": "l3-network", + "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" + }, + { + "from": "service-instance", + "to": "l3-network", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "complex", - "label": "locatedIn", + "from": "subnet", + "to": "l3-network", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "model-ver", - "to": "metadatum", - "label": "hasMetaData", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "entitlement", - "label": "has", + "from": "lag-interface", + "to": "lag-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "availability-zone", - "to": "service-capability", - "label": "supportsServiceCapability", + "from": "lag-interface", + "to": "p-interface", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "volume", - "label": "hasVolume", + "from": "l-interface", + "to": "lag-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { "from": "l3-interface-ipv4-address-list", - "to": "l3-network", - "label": "isMemberOf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "zone", - "label": "isMemberOf", + "from": "l3-interface-ipv6-address-list", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "service-instance", - "label": "hasInstance", + "from": "l-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", + "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "route-table-reference", - "label": "uses", + "from": "sriov-vf", + "to": "l-interface", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "model-element", - "to": "constrained-element-set", - "label": "connectsTo", + "from": "vlan", + "to": "l-interface", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "dvs-switch", - "to": "availability-zone", - "label": "existsIn", + "from": "logical-link", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "pserver", - "to": "lag-interface", - "label": "hasLAGInterface", + "from": "logical-link", + "to": "generic-vnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "availability-zone", - "label": "has", + "from": "logical-link", + "to": "lag-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "complex", - "label": "locatedIn", + "from": "logical-link", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "vlan", - "label": "isPartOf", + "from": "logical-link", + "to": "pnf", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -877,11 +901,11 @@ "default": "true" }, { - "from": "zone", - "to": "complex", - "label": "existsIn", + "from": "logical-link", + "to": "pserver", + "label": "org.onap.relationships.inventory.BridgedTo", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -889,285 +913,285 @@ "default": "true" }, { - "from": "site-pair", - "to": "class-of-service", - "label": "hasClassOfService", + "from": "logical-link", + "to": "vpn-binding", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "element-choice-set", - "to": "model-element", - "label": "has", + "from": "model-ver", + "to": "model", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "ctag-pool", - "to": "availability-zone", - "label": "supportsAvailabilityZone", + "from": "constrained-element-set", + "to": "model-constraint", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "l3-network", - "to": "network-policy", - "label": "uses", + "from": "constrained-element-set", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "port-group", - "label": "hasPortGroup", + "from": "model-constraint", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "complex", - "label": "locatedIn", + "from": "model-element", + "to": "model-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "vnf-image", - "label": "usesVnfImage", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "site-pair-set", - "to": "routing-instance", - "label": "hasRoutingInstance", + "from": "model-element", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "named-query", + "to": "model", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "l-interface", - "label": "hasLInterface", + "from": "named-query-element", + "to": "named-query", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "ONE2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "named-query-element", + "to": "model", + "label": "org.onap.relationships.inventory.IsA", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "allotted-resource", - "to": "generic-vnf", - "label": "isPartOf", + "from": "named-query-element", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license", - "label": "has", + "from": "property-constraint", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "pnf", - "to": "zone", - "label": "isMemberOf", + "from": "related-lookup", + "to": "named-query-element", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "l-interface", + "to": "newvce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "vce", - "to": "vserver", - "label": "runsOnVserver", + "from": "oam-network", + "to": "complex", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "subnet", - "label": "isMemberOf", + "from": "oam-network", + "to": "service-capability", + "label": "org.onap.relationships.inventory.AppliesTo", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "volume-group", - "label": "uses", + "from": "l-interface", + "to": "p-interface", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "pserver", - "label": "bridgedTo", + "from": "p-interface", + "to": "logical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "oam-network", - "label": "has", + "from": "p-interface", + "to": "physical-link", + "label": "tosca.relationships.network.LinksTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "dvs-switch", - "label": "has", + "from": "lag-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "has", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "from": "p-interface", + "to": "pnf", + "label": "tosca.relationships.network.BindsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "allotted-resource", - "label": "uses", + "from": "pnf", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "l3-network", - "label": "uses", + "from": "pnf", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1177,23 +1201,11 @@ "default": "true" }, { - "from": "cloud-region", - "to": "group-assignment", - "label": "has", - "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", - "default": "true" - }, - { - "from": "group-assignment", - "to": "tenant", - "label": "has", + "from": "pnf", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1201,83 +1213,83 @@ "default": "true" }, { - "from": "l-interface", - "to": "logical-link", - "label": "usesLogicalLink", + "from": "cvlan-tag", + "to": "port-group", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "virtual-data-center", - "to": "logical-link", - "label": "contains", + "from": "lag-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "named-query-element", - "label": "connectsTo", + "from": "p-interface", + "to": "pserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "connector", - "label": "uses", + "from": "pserver", + "to": "availability-zone", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "lag-interface", - "to": "lag-link", - "label": "usesLAGLink", + "from": "pserver", + "to": "cloud-region", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { "from": "pserver", - "to": "cloud-region", - "label": "locatedIn", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "logical-link", - "to": "generic-vnf", - "label": "bridgedTo", + "from": "pserver", + "to": "zone", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1285,108 +1297,108 @@ "default": "true" }, { - "from": "vce", - "to": "entitlement", - "label": "has", + "from": "site-pair", + "to": "routing-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "l3-network", - "label": "uses", + "from": "allotted-resource", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "l-interface", - "to": "sriov-vf", - "label": "has", + "from": "metadatum", + "to": "service-instance", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "model", - "label": "isA", + "from": "service-instance", + "to": "allotted-resource", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "group-assignment", - "to": "pserver", - "label": "has", + "from": "service-instance", + "to": "connector", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "snapshot", - "label": "has", + "from": "service-instance", + "to": "ctag-assignment", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "tenant", - "label": "has", + "from": "service-instance", + "to": "cvlan-tag", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", - "prevent-delete": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", "default": "true" }, { - "from": "cloud-region", - "to": "image", - "label": "has", + "from": "service-instance", + "to": "instance-group", + "label": "org.onap.relationships.inventory.MemberOf", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { - "from": "model-ver", - "to": "model-element", - "label": "startsWith", + "from": "service-instance", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", + "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", @@ -1394,10 +1406,10 @@ }, { "from": "service-instance", - "to": "cvlan-tag", - "label": "hasIPAGFacingVLAN", + "to": "pnf", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1405,23 +1417,11 @@ "default": "true" }, { - "from": "vserver", - "to": "l-interface", - "label": "hasLInterface", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", - "default": "true" - }, - { - "from": "generic-vnf", - "to": "instance-group", - "label": "isMemberOf", + "from": "service-instance", + "to": "service-instance", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", @@ -1429,69 +1429,69 @@ "default": "true" }, { - "from": "pnf", - "to": "lag-interface", - "label": "has", + "from": "service-instance", + "to": "vlan", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vserver", - "to": "snapshot", - "label": "uses", + "from": "service-instance", + "to": "service-subscription", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query-element", - "to": "property-constraint", - "label": "uses", + "from": "class-of-service", + "to": "site-pair", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-subscription", - "to": "service-instance", - "label": "hasInstance", + "from": "routing-instance", + "to": "site-pair-set", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "logical-link", - "label": "uses", + "from": "service-subscription", + "to": "tenant", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "${direction}", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { "from": "tenant", - "to": "service-subscription", - "label": "relatedTo", + "to": "l3-network", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1502,56 +1502,80 @@ }, { "from": "vserver", - "to": "pserver", - "label": "runsOnPserver", + "to": "tenant", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", "multiplicity": "MANY2ONE", - "contains-other-v": "NONE", + "contains-other-v": "!${direction}", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "service-instance", - "to": "vlan", - "label": "dependsOn", + "from": "entitlement", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", + "prevent-delete": "NONE", + "default": "true" + }, + { + "from": "license", + "to": "vce", + "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" }, + { + "from": "port-group", + "to": "vce", + "label": "org.onap.relationships.inventory.BelongsTo", + "direction": "OUT", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", + "prevent-delete": "NONE", + "default": "true" + }, { "from": "service-instance", - "to": "metadatum", - "label": "hasMetaData", + "to": "vce", + "label": "org.onap.relationships.inventory.ComposedOf", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "instance-group", - "label": "isMemberOf", + "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": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "availability-zone", - "label": "hasAvailabilityZone", + "from": "vce", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1561,11 +1585,11 @@ "default": "true" }, { - "from": "logical-link", - "to": "lag-link", - "label": "usesLAGLink", + "from": "vce", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", @@ -1573,45 +1597,45 @@ "default": "true" }, { - "from": "l3-network", - "to": "subnet", - "label": "hasSubnet", + "from": "vf-module", + "to": "l3-network", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "!${direction}", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "volume-group", - "to": "tenant", - "label": "belongsTo", + "from": "vf-module", + "to": "vnfc", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "${direction}", "default": "true" }, { - "from": "cloud-region", - "to": "complex", - "label": "locatedIn", + "from": "vf-module", + "to": "volume-group", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", "default": "true" }, { "from": "generic-vnf", - "to": "l3-network", - "label": "usesL3Network", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1621,69 +1645,57 @@ "default": "true" }, { - "from": "availability-zone", - "to": "complex", - "label": "groupsResourcesIn", + "from": "logical-link", + "to": "virtual-data-center", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "lag-interface", - "to": "l-interface", - "label": "hasLInterface", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "named-query", - "to": "named-query-element", - "label": "startsWith", + "from": "l3-interface-ipv4-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "service-instance", - "to": "ctag-assignment", - "label": "uses", + "from": "l3-interface-ipv6-address-list", + "to": "vlan", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "ONE2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "ipsec-configuration", - "label": "uses", + "from": "vlan", + "to": "logical-link", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2ONE", + "multiplicity": "MANY2MANY", "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "site-pair-set", - "label": "hasSitePairSet", + "from": "vlan", + "to": "multicast-configuration", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", @@ -1693,207 +1705,195 @@ "default": "true" }, { - "from": "model", - "to": "model-ver", - "label": "has", + "from": "tenant", + "to": "volume-group", + "label": "org.onap.relationships.inventory.DependsOn", "direction": "OUT", "multiplicity": "ONE2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "connector", - "to": "metadatum", - "label": "hasMetaData", + "from": "volume-group", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "generic-vnf", - "to": "network-profile", - "label": "hasNetworkProfile", + "from": "lag-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "NONE", - "delete-other-v": "NONE", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "vf-module", - "to": "volume-group", - "label": "uses", + "from": "p-interface", + "to": "vpls-pe", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "NONE", - "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "logical-link", - "to": "logical-link", - "label": "uses", + "from": "vpls-pe", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "SVC-INFRA": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-interface-ipv6-address-list", - "to": "l3-network", - "label": "isMemberOf", + "from": "vpls-pe", + "to": "ctag-pool", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", "multiplicity": "MANY2MANY", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "port-group", - "to": "cvlan-tag", - "label": "hasCTag", + "from": "l-interface", + "to": "vserver", + "label": "tosca.relationships.network.BindsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vpls-pe", - "to": "p-interface", - "label": "hasPinterface", + "from": "vf-module", + "to": "vserver", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "image", - "to": "metadatum", - "label": "hasMetaDatum", + "from": "vnfc", + "to": "vserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "multiplicity": "ONE2MANY", + "contains-other-v": "NONE", + "delete-other-v": "NONE", + "SVC-INFRA": "!${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "generic-vnf", - "to": "license-key-resource", - "label": "uses", + "from": "vserver", + "to": "flavor", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "l3-network", - "to": "vpn-binding", - "label": "usesVpnBinding", + "from": "vserver", + "to": "image", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "!${direction}", "default": "true" }, { - "from": "complex", - "to": "l3-network", - "label": "usesL3Network", + "from": "vserver", + "to": "pserver", + "label": "tosca.relationships.HostedOn", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "MANY2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" }, { - "from": "oam-network", - "to": "complex", - "label": "definedFor", + "from": "vserver", + "to": "snapshot", + "label": "org.onap.relationships.inventory.Uses", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2ONE", "contains-other-v": "NONE", "delete-other-v": "NONE", - "SVC-INFRA": "NONE", - "prevent-delete": "!${direction}", - "default": "true" - }, - { - "from": "vlan", - "to": "l3-interface-ipv4-address-list", - "label": "hasIpAddress", - "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "routing-instance", - "to": "site-pair", - "label": "hasSitePair", + "from": "vserver", + "to": "volume", + "label": "tosca.relationships.AttachesTo", "direction": "OUT", - "multiplicity": "MANY2MANY", + "multiplicity": "ONE2MANY", "contains-other-v": "${direction}", "delete-other-v": "${direction}", - "SVC-INFRA": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE", "default": "true" }, { - "from": "vlan", - "to": "l3-interface-ipv6-address-list", - "label": "hasIpAddress", + "from": "metadatum", + "to": "model-ver", + "label": "org.onap.relationships.inventory.BelongsTo", "direction": "OUT", - "multiplicity": "MANY2MANY", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", - "SVC-INFRA": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "!${direction}", + "delete-other-v": "!${direction}", + "SVC-INFRA": "NONE", "prevent-delete": "NONE", "default": "true" }, { - "from": "allotted-resource", - "to": "tunnel-xconnect", - "label": "has", + "from": "zone", + "to": "complex", + "label": "org.onap.relationships.inventory.LocatedIn", "direction": "OUT", - "multiplicity": "ONE2ONE", - "contains-other-v": "${direction}", - "delete-other-v": "${direction}", + "multiplicity": "MANY2ONE", + "contains-other-v": "NONE", + "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE", + "prevent-delete": "!${direction}", "default": "true" } ] diff --git a/aai-core/src/main/resources/edgeLabelMigration.csv b/aai-core/src/main/resources/edgeLabelMigration.csv new file mode 100644 index 00000000..f675ce8d --- /dev/null +++ b/aai-core/src/main/resources/edgeLabelMigration.csv @@ -0,0 +1,212 @@ +from,to,label,direction,multiplicity,contains-other-v,delete-other-v,SVC-INFRA,prevent-delete,new from,new to,new label,new direction,new multiplicity,new contains-other-v,new delete-other-v,new SVC-INFRA,new prevent-delete,new default +allotted-resource,allotted-resource,bindsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,allotted-resource,allotted-resource,tosca.relationships.network.BindsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +allotted-resource,generic-vnf,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,generic-vnf,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,l3-network,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,l3-network,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,l-interface,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,allotted-resource,l-interface,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,network-policy,uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,allotted-resource,network-policy,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +allotted-resource,vlan,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,vlan,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,vpn-binding,belongsTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},allotted-resource,vpn-binding,org.onap.relationships.inventory.BelongsTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +allotted-resource,tunnel-xconnect,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,tunnel-xconnect,allotted-resource,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +availability-zone,complex,groupsResourcesIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},availability-zone,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +availability-zone,service-capability,supportsServiceCapability,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},availability-zone,service-capability,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +cloud-region,availability-zone,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},availability-zone,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},cloud-region,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +cloud-region,l3-network,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,cloud-region,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +cloud-region,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,cloud-region,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +cloud-region,dvs-switch,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},dvs-switch,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,flavor,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},flavor,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,group-assignment,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},group-assignment,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,image,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},image,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,oam-network,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},oam-network,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,snapshot,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},snapshot,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,tenant,has,OUT,ONE2MANY,${direction},${direction},!${direction},${direction},tenant,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,${direction},!${direction},T +cloud-region,vip-ipv4-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vip-ipv4-address-list,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,vip-ipv6-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vip-ipv6-address-list,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,volume-group,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},volume-group,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +complex,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,${direction},NONE,complex,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +complex,ctag-pool,hasCtagPool,OUT,MANY2MANY,${direction},${direction},NONE,NONE,ctag-pool,complex,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +configuration,allotted-resource,uses,OUT,ONE2ONE,NONE,${direction},NONE,NONE,configuration,allotted-resource,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,${direction},NONE,NONE,T +configuration,logical-link,has,OUT,ONE2MANY,NONE,${direction},NONE,NONE,configuration,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +configuration,metadatum,owns,OUT,ONE2MANY,${direction},${direction},NONE,NONE,metadatum,configuration,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +connector,virtual-data-center,contains,OUT,MANY2MANY,NONE,NONE,NONE,NONE,connector,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +connector,metadatum,hasMetaData,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,connector,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +constrained-element-set,element-choice-set,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,element-choice-set,constrained-element-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +ctag-pool,availability-zone,supportsAvailabilityZone,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},ctag-pool,availability-zone,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +customer,service-subscription,subscribesTo,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,service-subscription,customer,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +dvs-switch,availability-zone,existsIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},dvs-switch,availability-zone,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +element-choice-set,model-element,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,element-choice-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,entitlement,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,entitlement,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,availability-zone,hasAvailabilityZone,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},generic-vnf,availability-zone,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +generic-vnf,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},generic-vnf,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +generic-vnf,configuration,uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,generic-vnf,configuration,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +generic-vnf,ctag-pool,usesCtagPool,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,ctag-pool,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,ipsec-configuration,uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,generic-vnf,ipsec-configuration,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +generic-vnf,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,${direction},NONE,generic-vnf,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,license-key-resource,uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},generic-vnf,license-key-resource,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +generic-vnf,pnf,hostedOn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,pnf,tosca.relationships.HostedOn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,pserver,runsOnPserver,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},generic-vnf,pserver,tosca.relationships.HostedOn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +generic-vnf,vnfc,uses,OUT,ONE2MANY,NONE,${direction},${direction},NONE,vnfc,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,NONE,!${direction},!${direction},NONE,T +generic-vnf,vnf-image,usesVnfImage,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},generic-vnf,vnf-image,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +generic-vnf,volume-group,uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,generic-vnf,volume-group,org.onap.relationships.inventory.DependsOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,vserver,runsOnVserver,OUT,ONE2MANY,NONE,NONE,${direction},NONE,generic-vnf,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,lag-interface,hasLAGInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,lag-interface,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +generic-vnf,license,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,license,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +generic-vnf,network-profile,hasNetworkProfile,OUT,MANY2MANY,NONE,NONE,NONE,NONE,network-profile,generic-vnf,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,service-instance,hasInstance,OUT,MANY2MANY,NONE,NONE,${direction},NONE,service-instance,generic-vnf,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +generic-vnf,site-pair-set,hasSitePairSet,OUT,MANY2MANY,NONE,NONE,NONE,NONE,site-pair-set,generic-vnf,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,vf-module,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vf-module,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +group-assignment,pserver,has,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},pserver,group-assignment,org.onap.relationships.inventory.MemberOf,OUT,MANY2ONE,NONE,NONE,NONE,${direction},T +group-assignment,tenant,has,OUT,MANY2MANY,NONE,NONE,NONE,NONE,tenant,group-assignment,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +image,metadatum,hasMetaDatum,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,image,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +instance-group,model,targets,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},instance-group,model,org.onap.relationships.inventory.Targets,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +ipsec-configuration,vig-server,hasVigServer,OUT,ONE2MANY,${direction},${direction},NONE,NONE,vig-server,ipsec-configuration,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +l3-interface-ipv4-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-interface-ipv4-address-list,instance-group,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-interface-ipv4-address-list,l3-network,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-interface-ipv4-address-list,l3-network,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-interface-ipv4-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},l3-interface-ipv4-address-list,subnet,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +l3-interface-ipv6-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-interface-ipv6-address-list,instance-group,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-interface-ipv6-address-list,l3-network,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-interface-ipv6-address-list,l3-network,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-interface-ipv6-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},l3-interface-ipv6-address-list,subnet,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +l3-network,ctag-assignment,hasCtagAssignment,OUT,MANY2MANY,${direction},${direction},${direction},NONE,ctag-assignment,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l3-network,instance-group,memberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-network,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-network,network-policy,uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-network,network-policy,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-network,route-table-reference,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-network,route-table-reference,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-network,vpn-binding,usesVpnBinding,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},l3-network,vpn-binding,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +l3-network,segmentation-assignment,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,segmentation-assignment,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +l3-network,service-instance,hasInstance,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,service-instance,l3-network,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +l3-network,subnet,hasSubnet,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,subnet,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +lag-interface,lag-link,usesLAGLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,lag-interface,lag-link,tosca.relationships.network.LinksTo,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +lag-interface,logical-link,uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,lag-interface,logical-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +lag-interface,p-interface,usesPInterface,OUT,MANY2MANY,NONE,NONE,${direction},NONE,lag-interface,p-interface,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +lag-interface,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,lag-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +line-of-business,generic-vnf,realizedBy,OUT,MANY2MANY,NONE,NONE,NONE,NONE,line-of-business,generic-vnf,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l-interface,l3-interface-ipv4-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv4-address-list,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,l3-interface-ipv6-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv6-address-list,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l-interface,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l-interface,l-interface,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,l-interface,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,logical-link,usesLogicalLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,l-interface,logical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,${direction},${direction},NONE,T +l-interface,logical-link,sourceLInterface,OUT,MANY2MANY,NONE,${direction},${direction},NONE,logical-link,l-interface,org.onap.relationships.inventory.Source,OUT,ONE2MANY,NONE,!${direction},!${direction},NONE,F +l-interface,logical-link,targetLInterface,OUT,MANY2MANY,NONE,${direction},${direction},NONE,logical-link,l-interface,org.onap.relationships.inventory.Destination,OUT,ONE2MANY,NONE,!${direction},!${direction},NONE,F +l-interface,sriov-vf,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,sriov-vf,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +l-interface,vlan,hasVlan,OUT,MANY2MANY,${direction},${direction},NONE,NONE,vlan,l-interface,tosca.relationships.network.LinksTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +logical-link,cloud-region,existsIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,cloud-region,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,generic-vnf,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,generic-vnf,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,lag-link,usesLAGLink,OUT,MANY2MANY,NONE,NONE,${direction},NONE,logical-link,lag-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +logical-link,logical-link,uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,logical-link,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +logical-link,pnf,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,pnf,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,pserver,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},logical-link,pserver,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +logical-link,vpn-binding,uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},logical-link,vpn-binding,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +model,model-ver,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-ver,model,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-constraint,constrained-element-set,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,constrained-element-set,model-constraint,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,constrained-element-set,connectsTo,OUT,ONE2MANY,${direction},${direction},NONE,NONE,constrained-element-set,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-constraint,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-constraint,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-element,connectsTo,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-ver,isA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},model-element,model-ver,org.onap.relationships.inventory.IsA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +model-ver,metadatum,hasMetaDatum,OUT,ONE2MANY,${direction},${direction},NONE,NONE,metadatum,model-ver,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-ver,model-element,startsWith,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,model-ver,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query,model,relatedTo,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},named-query,model,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},T +named-query,named-query-element,startsWith,OUT,ONE2ONE,${direction},${direction},NONE,NONE,named-query-element,named-query,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,model,isA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},named-query-element,model,org.onap.relationships.inventory.IsA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +named-query-element,named-query-element,connectsTo,OUT,MANY2MANY,${direction},${direction},NONE,NONE,named-query-element,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,property-constraint,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,property-constraint,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,related-lookup,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,related-lookup,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +newvce,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,l-interface,newvce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +oam-network,complex,definedFor,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},oam-network,complex,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +oam-network,service-capability,supportsServiceCapability,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},oam-network,service-capability,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +operational-environment,operational-environment,managedBy,OUT,ONE2ONE,NONE,NONE,NONE,NONE,operational-environment,operational-environment,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +owning-entity,service-instance,owns,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,owning-entity,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +p-interface,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,p-interface,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +p-interface,logical-link,usesLogicalLink,OUT,MANY2ONE,NONE,NONE,${direction},NONE,p-interface,logical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +p-interface,physical-link,usesPhysicalLink,OUT,MANY2MANY,NONE,${direction},NONE,NONE,p-interface,physical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,${direction},NONE,NONE,T +p-interface,sriov-pf,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,sriov-pf,p-interface,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +platform,generic-vnf,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,platform,generic-vnf,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +pnf,lag-interface,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,lag-interface,pnf,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pnf,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,p-interface,pnf,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pnf,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},pnf,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +pnf,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,pnf,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +pnf,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,pnf,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +port-group,cvlan-tag,hasCTag,OUT,MANY2MANY,${direction},${direction},${direction},NONE,cvlan-tag,port-group,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +project,service-instance,created,OUT,ONE2MANY,NONE,NONE,NONE,NONE,project,service-instance,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +pserver,lag-interface,hasLAGInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,lag-interface,pserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pserver,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,p-interface,pserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pserver,availability-zone,existsIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},pserver,availability-zone,org.onap.relationships.inventory.MemberOf,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +pserver,cloud-region,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,pserver,cloud-region,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +pserver,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},pserver,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +pserver,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,pserver,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +routing-instance,site-pair,hasSitePair,OUT,MANY2MANY,${direction},${direction},NONE,NONE,site-pair,routing-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,allotted-resource,has,OUT,MANY2MANY,${direction},${direction},NONE,NONE,allotted-resource,service-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,metadatum,hasMetaData,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,service-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,allotted-resource,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,allotted-resource,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,configuration,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,configuration,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,connector,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,connector,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,ctag-assignment,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,ctag-assignment,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,cvlan-tag,hasIPAGFacingVLAN,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,cvlan-tag,org.onap.relationships.inventory.ComposedOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,logical-link,uses,OUT,MANY2MANY,NONE,${direction},NONE,NONE,service-instance,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +service-instance,pnf,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,pnf,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,service-instance,dependsOn,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,service-instance,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,vlan,dependsOn,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,vlan,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,zone,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,service-instance,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +service-subscription,service-instance,hasInstance,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,service-instance,service-subscription,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +site-pair,class-of-service,hasClassOfService,OUT,MANY2MANY,${direction},${direction},NONE,NONE,class-of-service,site-pair,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +site-pair-set,routing-instance,hasRoutingInstance,OUT,MANY2MANY,${direction},${direction},NONE,NONE,routing-instance,site-pair-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +sriov-vf,sriov-pf,uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,sriov-vf,sriov-pf,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +subnet,host-route,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,host-route,subnet,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +tenant,service-subscription,relatedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-subscription,tenant,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +tenant,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,NONE,NONE,tenant,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +tenant,vserver,owns,OUT,ONE2MANY,${direction},${direction},!${direction},${direction},vserver,tenant,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,${direction},!${direction},T +vce,entitlement,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,entitlement,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vce,license,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,license,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vce,port-group,hasPortGroup,OUT,MANY2MANY,${direction},${direction},${direction},NONE,port-group,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vce,service-instance,hasServiceInstance,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,service-instance,vce,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +vce,availability-zone,hasAvailabilityZone,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},vce,availability-zone,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +vce,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vce,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +vce,vserver,runsOnVserver,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vce,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +vf-module,l3-network,uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vf-module,l3-network,org.onap.relationships.inventory.DependsOn,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +vf-module,vnfc,uses,OUT,ONE2MANY,NONE,${direction},${direction},${direction},vf-module,vnfc,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,${direction},${direction},T +vf-module,volume-group,uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,vf-module,volume-group,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,T +vip-ipv4-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vip-ipv4-address-list,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vip-ipv4-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vip-ipv4-address-list,subnet,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +vip-ipv6-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vip-ipv6-address-list,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vip-ipv6-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vip-ipv6-address-list,subnet,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +virtual-data-center,generic-vnf,hasVNF,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,generic-vnf,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +virtual-data-center,logical-link,contains,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vlan,l3-interface-ipv4-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv4-address-list,vlan,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vlan,l3-interface-ipv6-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv6-address-list,vlan,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vlan,logical-link,usesLogicalLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,vlan,logical-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +vlan,multicast-configuration,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vlan,multicast-configuration,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,l3-interface-ipv4-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},NONE,NONE,l3-interface-ipv4-address-list,vnfc,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vnfc,l3-interface-ipv6-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},NONE,NONE,l3-interface-ipv6-address-list,vnfc,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vnfc,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,vip-ipv4-address-list,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,vip-ipv4-address-list,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,vip-ipv6-address-list,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,vip-ipv6-address-list,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +volume-group,tenant,belongsTo,OUT,MANY2MANY,NONE,NONE,${direction},NONE,tenant,volume-group,org.onap.relationships.inventory.DependsOn,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +volume-group,complex,existsIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},volume-group,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vpls-pe,lag-interface,hasLAGinterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,lag-interface,vpls-pe,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vpls-pe,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,p-interface,vpls-pe,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vpls-pe,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},vpls-pe,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +vpls-pe,ctag-pool,usesCtagPool,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vpls-pe,ctag-pool,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vpn-binding,route-target,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,route-target,vpn-binding,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vserver,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,vserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vserver,vf-module,isPartOf,OUT,MANY2ONE,NONE,NONE,${direction},NONE,vf-module,vserver,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +vserver,vnfc,hosts,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vnfc,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +vserver,flavor,hasFlavor,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,flavor,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,image,hasImage,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,image,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,pserver,runsOnPserver,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,pserver,tosca.relationships.HostedOn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,snapshot,uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,vserver,snapshot,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,T +vserver,volume,hasVolume,OUT,MANY2MANY,${direction},${direction},${direction},NONE,vserver,volume,tosca.relationships.AttachesTo,OUT,ONE2MANY,${direction},${direction},${direction},NONE,T +zone,complex,existsIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},zone,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +,,,,,,,,,allotted-resource,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,generic-vnf,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,l3-network,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,logical-link,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,service-instance,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,vf-module,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +configuration,l-interface,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,configuration,l-interface,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +configuration,pnf,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,configuration,pnf,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +forwarder,forwarding-path,belongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,forwarder,forwarding-path,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +forwarding-path,service-instance,implements,OUT,MANY2ONE,NONE,!${direction},NONE,NONE,forwarding-path,service-instance,org.onap.relationships.inventory.AppliesTo,OUT,MANY2ONE,NONE,!${direction},NONE,NONE,T +forwarder,l-interface,forwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,forwarder,l-interface,org.onap.relationships.inventory.ForwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +forwarder,p-interface,forwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,forwarder,p-interface,org.onap.relationships.inventory.ForwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T diff --git a/aai-core/src/main/resources/edgerulesTemplate.ftlh b/aai-core/src/main/resources/edgerulesTemplate.ftlh new file mode 100644 index 00000000..2223cc37 --- /dev/null +++ b/aai-core/src/main/resources/edgerulesTemplate.ftlh @@ -0,0 +1,8 @@ +{ + "rules": [ +<#list wrappedRules as rule> +<#include "ruleTemplate.ftlh"> +<#if rule_has_next>, + + ] +} \ No newline at end of file diff --git a/aai-core/src/main/resources/ruleTemplate.ftlh b/aai-core/src/main/resources/ruleTemplate.ftlh new file mode 100644 index 00000000..00865279 --- /dev/null +++ b/aai-core/src/main/resources/ruleTemplate.ftlh @@ -0,0 +1,12 @@ + { + "from": "${rule.from}", + "to": "${rule.to}", + "label": "${rule.label}", + "direction": "${rule.direction}", + "multiplicity": "${rule.multiplicity}", + "contains-other-v": "${rule.lineage}", + "delete-other-v": "${rule.deleteOtherV}", + "SVC-INFRA": "${rule.svcInfra}", + "prevent-delete": "${rule.preventDelete}", + "default": "${rule.default}" + } \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/dbmap/AAIGraphTest.java b/aai-core/src/test/java/org/onap/aai/dbmap/AAIGraphTest.java new file mode 100644 index 00000000..e358dc8e --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/dbmap/AAIGraphTest.java @@ -0,0 +1,79 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ + +package org.onap.aai.dbmap; + +import com.thinkaurelius.titan.core.TitanFactory; +import com.thinkaurelius.titan.core.TitanGraph; +import com.thinkaurelius.titan.core.schema.TitanManagement; +import org.hamcrest.CoreMatchers; +import org.junit.*; +import org.onap.aai.AAISetup; +import org.onap.aai.util.AAIConstants; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.Matchers.matchesPattern; +import static org.junit.Assert.*; + +public class AAIGraphTest extends AAISetup{ + + private static final String SERVICE_NAME = "JUNIT"; + + @Before + public void setup() { + System.setProperty("aai.service.name", SERVICE_NAME); + AAIGraph.getInstance(); + } + + @Test + public void getRealtimeInstanceConnectionName() throws Exception { + + TitanManagement graphMgt = AAIGraph.getInstance().getGraph().openManagement(); + String connectionInstanceName = graphMgt.getOpenInstances().stream().filter(c -> c.contains("current")).findFirst().get(); + assertThat(connectionInstanceName, containsString(SERVICE_NAME)); + assertThat(connectionInstanceName, containsString("realtime")); + assertThat(connectionInstanceName, matchesPattern("^\\d+_[\\w\\-\\d]+_" + SERVICE_NAME + "_realtime_\\d+\\(current\\)$")); + graphMgt.rollback(); + } + + @Test + public void getCachedInstanceConnectionName() throws Exception { + + TitanManagement graphMgt = AAIGraph.getInstance().getGraph(DBConnectionType.CACHED).openManagement(); + String connectionInstanceName = graphMgt.getOpenInstances().stream().filter(c -> c.contains("current")).findFirst().get(); + assertThat(connectionInstanceName, containsString(SERVICE_NAME)); + assertThat(connectionInstanceName, containsString("cached")); + assertThat(connectionInstanceName, matchesPattern("^\\d+_[\\w\\-\\d]+_" + SERVICE_NAME + "_cached_\\d+\\(current\\)$")); + graphMgt.rollback(); + } + + @Test + public void titanGraphOpenNameTest() throws Exception{ + TitanGraph graph = TitanFactory.open(new AAIGraphConfig.Builder(AAIConstants.REALTIME_DB_CONFIG).forService(SERVICE_NAME).withGraphType("graphType").buildConfiguration()); + TitanManagement graphMgt = graph.openManagement(); + String connectionInstanceName = graphMgt.getOpenInstances().stream().filter(c -> c.contains("current")).findFirst().get(); + assertThat(connectionInstanceName,matchesPattern("^\\d+_[\\w\\-\\d]+_" + SERVICE_NAME + "_graphType_\\d+\\(current\\)$")); + graphMgt.rollback(); + graph.close(); + } + +} \ No newline at end of file diff --git a/aai-core/src/test/java/org/onap/aai/introspection/JSONStrategyTest.java b/aai-core/src/test/java/org/onap/aai/introspection/JSONStrategyTest.java new file mode 100644 index 00000000..64856899 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/JSONStrategyTest.java @@ -0,0 +1,136 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.introspection; + +import org.json.simple.JSONArray; +import org.json.simple.JSONObject; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; + +import java.util.HashSet; +import java.util.Set; + +public class JSONStrategyTest extends AAISetup{ + private JSONStrategy jsonStrategy; + private JSONStrategy jsonStrategyContainer; + private JSONStrategy jsonStrategyComplex; + + @Before + public void setup(){ + try { + JSONObject pserver = new JSONObject(); + pserver.put("hostname", "value1"); + pserver.put("numberofCpus", 4); + jsonStrategy = new JSONStrategy(pserver, "pserver-type"); + + // The values of this object are arrays containing JSONObjects + JSONArray pservers = new JSONArray(); + pservers.add(pserver); + JSONObject container = new JSONObject(); + container.put("pservers", pservers); + jsonStrategyContainer = new JSONStrategy(container, "pservers-type"); + + // The values of this object are JSONObjects + JSONObject complex = new JSONObject(); + complex.put("pserver", pserver); + jsonStrategyComplex = new JSONStrategy(complex, "pservers-type"); + } + catch (Exception e){ + System.out.println("error during setup: " + e.getMessage()); + } + } + + @Test + public void getSetTest(){ + jsonStrategy.setValue("ramInMegabytes", 1024); + Assert.assertEquals("value1", jsonStrategy.getValue("hostname")); + Assert.assertEquals(4, jsonStrategy.getValue("numberofCpus")); + Assert.assertEquals(1024, jsonStrategy.getValue("ramInMegabytes")); + } + + @Test + public void getPropertiesTest() { + Set expected = new HashSet<>(); + expected.add("hostname"); + expected.add("numberofCpus"); + Assert.assertEquals(expected, jsonStrategy.getProperties()); + } + + @Test + public void getGenericTypeTest() { + // If the values of this object are arrays, return the type within the array + Assert.assertEquals("class org.json.simple.JSONObject" , jsonStrategyContainer.getGenericTypeClass("pservers").toString()); + } + + @Test + public void getJavaClassNameTest() { + Assert.assertEquals("org.json.simple.JSONObject", jsonStrategy.getJavaClassName()); + Assert.assertEquals("org.json.simple.JSONObject", jsonStrategyContainer.getJavaClassName()); + } + @Test + public void getTypeTest() { + Assert.assertEquals("java.lang.String", jsonStrategy.getType("hostname")); + Assert.assertEquals("java.lang.Integer", jsonStrategy.getType("numberofCpus")); + } + + @Test + public void isContainerTest() { + Assert.assertTrue(jsonStrategyContainer.isContainer()); + } + + @Test + public void newInstanceOfPropertyTest() { + Assert.assertEquals("class org.json.simple.JSONArray", jsonStrategyContainer.newInstanceOfProperty("pservers").getClass().toString()); + } + + @Test(expected = NullPointerException.class) + public void newInvalidInstanceOfPropertyTest() { + Assert.assertEquals(null, jsonStrategyContainer.newInstanceOfProperty("invalid").getClass().toString()); + } + @Test + public void newInstanceOfNestedPropertyTest() { + Assert.assertEquals("class org.json.simple.JSONObject", jsonStrategyContainer.newInstanceOfNestedProperty("pservers").getClass().toString()); + } + + @Test(expected = NullPointerException.class) + public void newInvalidInstanceOfNestedPropertyTest() { + jsonStrategyContainer.newInstanceOfNestedProperty("invalid").getClass().toString(); + } + + @Test + public void isComplexTypeTest() { + // Complex: The value of this key contains a JSONObject + Assert.assertTrue(jsonStrategyComplex.isComplexType("pserver")); + Assert.assertFalse(jsonStrategyContainer.isComplexType("pservers")); + Assert.assertFalse(jsonStrategy.isComplexType("hostname")); + } + + @Test + public void isComplexGenericTypeTest() { + // Complex Generic: The value of this key contains an array of JSONObjects + Assert.assertTrue(jsonStrategyContainer.isComplexGenericType("pservers")); + Assert.assertFalse(jsonStrategyComplex.isComplexGenericType("pserver")); + Assert.assertFalse(jsonStrategy.isComplexGenericType("hostname")); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/introspection/PropertyPredicatesTest.java b/aai-core/src/test/java/org/onap/aai/introspection/PropertyPredicatesTest.java index 0250bbb3..d5eaf0b6 100644 --- a/aai-core/src/test/java/org/onap/aai/introspection/PropertyPredicatesTest.java +++ b/aai-core/src/test/java/org/onap/aai/introspection/PropertyPredicatesTest.java @@ -29,6 +29,7 @@ import org.onap.aai.introspection.exceptions.AAIUnknownObjectException; import java.util.Set; import static org.hamcrest.Matchers.hasItems; +import static org.hamcrest.Matchers.is; import static org.hamcrest.Matchers.not; import static org.junit.Assert.assertThat; @@ -43,33 +44,33 @@ public class PropertyPredicatesTest extends AAISetup { @Before public void setup() throws Exception { loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); - obj = loader.introspectorFromName("test-object"); + obj = loader.introspectorFromName("generic-vnf"); } @Test public void includeInTestGeneration() throws AAIUnknownObjectException { Set props = obj.getProperties(PropertyPredicates.includeInTestGeneration()); - - assertThat("props not found", props, - not(hasItems("persona-model-ver", "not-visible-test-element", "model-invariant-id", "model-version-id"))); + + assertThat("props not found", props, + not(hasItems("model-invariant-id", "model-version-id"))); } @Test public void isVisible() throws AAIUnknownObjectException { Set props = obj.getProperties(PropertyPredicates.isVisible()); - - assertThat("props not found", props, not(hasItems("persona-model-ver"))); + + assertThat("props not found", props, hasItems("model-invariant-id", "model-version-id")); } @Test public void all() throws AAIUnknownObjectException { Set props = obj.getProperties(); - - assertThat("all found", props, hasItems("persona-model-ver", "not-visible-test-element")); + + assertThat("all found", props, hasItems("model-invariant-id", "model-version-id")); } - + } 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 4a870995..7d3cafac 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 @@ -83,9 +83,11 @@ public class DataCopyTest { 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").addInE("has", "v1", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key2", "model-version", "testValue") + .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").addInE("has", "v2", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "model-ver", "model-ver", "myValue", "model-version-id", "key4") + .addOutE("org.onap.relationships.inventory.BelongsTo", "v2", EdgeProperty.CONTAINS.toString(), true) .next(); graph.tx().commit(); } @@ -105,7 +107,7 @@ public class DataCopyTest { public void runPopulatePersonaModelVer() throws URISyntaxException, AAIException, UnsupportedEncodingException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, SecurityException, InstantiationException, NoSuchMethodException, MalformedURLException { final Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); - final Introspector obj = loader.introspectorFromName("test-object"); + final Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "myId"); obj.setValue("model-invariant-id", "key1"); obj.setValue("model-version-id", "key2"); @@ -123,7 +125,7 @@ public class DataCopyTest { runner.execute(obj, self); - assertEquals("value populated", "testValue", obj.getValue("persona-model-ver")); + assertEquals("value populated", "testValue", obj.getValue("persona-model-version")); g.tx().rollback(); @@ -134,7 +136,7 @@ public class DataCopyTest { public void runPopulateModelVersionId() throws URISyntaxException, AAIException, UnsupportedEncodingException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, SecurityException, InstantiationException, NoSuchMethodException, MalformedURLException { final Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v9); - final Introspector obj = loader.introspectorFromName("test-object"); + final Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "myId"); obj.setValue("persona-model-id", "key1"); obj.setValue("persona-model-version", "testValue"); @@ -187,7 +189,7 @@ public class DataCopyTest { public void expectedMissingPropertyExceptionInURI() throws AAIException, UnsupportedEncodingException { final Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); - final Introspector obj = loader.introspectorFromName("test-object"); + final Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "myId"); obj.setValue("model-invariant-id", "key1"); @@ -210,7 +212,7 @@ public class DataCopyTest { @Test public void expectedMissingPropertyExceptionForResultingObject() throws AAIException, UnsupportedEncodingException { final Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); - final Introspector obj = loader.introspectorFromName("test-object"); + final Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "myId"); obj.setValue("model-invariant-id", "key3"); obj.setValue("model-version-id", "key4"); @@ -234,7 +236,7 @@ public class DataCopyTest { @Test public void expectNoProcessingWithNoProperties() throws AAIException, UnsupportedEncodingException { final Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); - final Introspector obj = loader.introspectorFromName("test-object"); + final Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "myId"); TransactionalGraphEngine spy = spy(dbEngine); 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 b817cc69..684bb5b8 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 @@ -31,6 +31,7 @@ import org.junit.*; import org.junit.rules.ExpectedException; import org.mockito.Mock; import org.mockito.MockitoAnnotations; +import org.onap.aai.AAISetup; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.dbmap.DBConnectionType; import org.onap.aai.exceptions.AAIException; @@ -52,7 +53,7 @@ import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; -public class DataLinkTest { +public class DataLinkTest extends AAISetup { private static TitanGraph graph; private final static Version version = Version.getLatest(); @@ -71,8 +72,6 @@ public class DataLinkTest { @BeforeClass public static void setup() throws NoSuchFieldException, SecurityException, Exception { graph = TitanFactory.build().set("storage.backend","inmemory").open(); - System.setProperty("AJSC_HOME", "."); - System.setProperty("BUNDLECONFIG_DIR", "src/test/resources/bundleconfig-local"); loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); dbEngine = new TitanDBEngine( queryStyle, @@ -81,13 +80,17 @@ public class DataLinkTest { 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).addInE("has", "v2", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "route-target", "global-route-target", "modifyTargetKey", "route-target-role", "modifyRoleKey", "linked", true) + .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).addInE("has", "v3", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "route-target", "global-route-target", "deleteTargetKey", "route-target-role", "deleteRoleKey", "linked", true) + .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).addInE("has", "v4", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "route-target", "global-route-target", "getTargetKey", "route-target-role", "getRoleKey", "linked", true) + .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").addInE("has", "v5", EdgeProperty.CONTAINS.toString(), true) + .addV("aai-node-type", "route-target", "global-route-target", "getTargetKeyNoLink", "route-target-role", "getRoleKeyNoLink") + .addOutE("org.onap.relationships.inventory.BelongsTo", "v5", EdgeProperty.CONTAINS.toString(), true) .next(); graph.tx().commit(); } @@ -187,7 +190,12 @@ public class DataLinkTest { runner.execute(obj, self); assertEquals("route-target vertex not found", false, traversal.V() - .has(AAIProperties.NODE_TYPE, "route-target").has("global-route-target", "deleteTargetKey").has("route-target-role", "deleteRoleKey").has("linked", true).hasNext()); + .has(AAIProperties.NODE_TYPE, "route-target") + .has("global-route-target", "deleteTargetKey") + .has("route-target-role", "deleteRoleKey") + .has("linked", true) + .hasNext() + ); g.tx().rollback(); } diff --git a/aai-core/src/test/java/org/onap/aai/introspection/tools/CreateUUIDTest.java b/aai-core/src/test/java/org/onap/aai/introspection/tools/CreateUUIDTest.java new file mode 100644 index 00000000..bb2604ec --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/introspection/tools/CreateUUIDTest.java @@ -0,0 +1,91 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +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.assertFalse; +import static org.junit.Assert.assertTrue; + +public class CreateUUIDTest extends AAISetup { + + private CreateUUID createUUID; + + private Loader loader; + private Issue issue; + + @Before + public void setup(){ + createUUID = new CreateUUID(); + loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); + } + + /** + * Tests to check if the issue is not resolvable since + * the property that is being tested doesn't have the auto generated uuid + * metadata set to true in the oxm xml for the version specified + * + * @throws AAIUnknownObjectException - if the object type specified is unable to be found in the oxm + */ + @Test + public void testNonResolvableIssueIfMissingPropNameThatIsRequired() throws AAIUnknownObjectException { + + Introspector introspector = loader.introspectorFromName("pserver"); + + issue = new Issue(); + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_KEY_PROP); + issue.setPropName("hostname"); + issue.setIntrospector(introspector); + + boolean isIssue = createUUID.resolveIssue(issue); + + assertFalse(isIssue); + } + + /** + * Tests when there is a resolvable issue when the property + * looking for, model-element-uuid, has the auto generated uuid + * metadata attribute associated to it if the data is missing + * + * @throws AAIUnknownObjectException - if the object type specified is unable to be found in the oxm + */ + @Test + public void testResolvableIssueWhenMissingPropNameAllowsToUseGeneratedUUID() throws AAIUnknownObjectException { + + Introspector introspector = loader.introspectorFromName("model-element"); + + issue = new Issue(); + issue.setDetail("Some message"); + issue.setType(IssueType.MISSING_KEY_PROP); + issue.setPropName("model-element-uuid"); + issue.setIntrospector(introspector); + + boolean isIssue = createUUID.resolveIssue(issue); + assertTrue(isIssue); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/introspection/validation/IntrospectorValidationTest.java b/aai-core/src/test/java/org/onap/aai/introspection/validation/IntrospectorValidationTest.java index db21f578..3bba4ee0 100644 --- a/aai-core/src/test/java/org/onap/aai/introspection/validation/IntrospectorValidationTest.java +++ b/aai-core/src/test/java/org/onap/aai/introspection/validation/IntrospectorValidationTest.java @@ -63,7 +63,7 @@ public class IntrospectorValidationTest { @Ignore @Test public void verifySuccessWhenEmpty() throws AAIException { - Introspector obj = loader.introspectorFromName("test-object"); + Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "key1"); validator.validate(obj); List issues = validator.getIssues(); @@ -73,7 +73,7 @@ public class IntrospectorValidationTest { @Ignore @Test public void verifyRequiresSingleFieldFailure() throws AAIException { - Introspector obj = loader.introspectorFromName("test-object"); + Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "key1"); obj.setValue("model-invariant-id", "id1"); validator.validate(obj); @@ -85,7 +85,7 @@ public class IntrospectorValidationTest { @Ignore @Test public void verifyRequiresSuccess() throws AAIException { - Introspector obj = loader.introspectorFromName("test-object"); + Introspector obj = loader.introspectorFromName("generic-vnf"); obj.setValue("vnf-id", "key1"); obj.setValue("model-invariant-id", "id1"); obj.setValue("model-version-id", "version-id1"); diff --git a/aai-core/src/test/java/org/onap/aai/logging/EcompErrorCategoryTest.java b/aai-core/src/test/java/org/onap/aai/logging/EcompErrorCategoryTest.java new file mode 100644 index 00000000..485a63f2 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/logging/EcompErrorCategoryTest.java @@ -0,0 +1,50 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import static org.junit.Assert.*; +import static org.mockito.Mockito.*; + +import ch.qos.logback.classic.Level; + +import ch.qos.logback.classic.spi.ILoggingEvent; +import org.junit.*; + +public class EcompErrorCategoryTest { + + EcompErrorCategory _ecompErrorCategory; + ILoggingEvent mockEvent; + + @Before + public void setUp() throws Exception { + + mockEvent = mock(ILoggingEvent.class); + _ecompErrorCategory= spy(EcompErrorCategory.class); + + } + @Test + public void warn(){ + String defaultCategory = "WARN"; + assertEquals(_ecompErrorCategory.convert(mockEvent), defaultCategory); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/logging/EcompResponseCodeTest.java b/aai-core/src/test/java/org/onap/aai/logging/EcompResponseCodeTest.java new file mode 100644 index 00000000..522aeb2b --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/logging/EcompResponseCodeTest.java @@ -0,0 +1,49 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import static org.junit.Assert.*; +import static org.mockito.Mockito.*; + +import ch.qos.logback.classic.Level; + +import ch.qos.logback.classic.spi.ILoggingEvent; +import org.junit.*; + +public class EcompResponseCodeTest { + + EcompResponseCode _ecompResponseCode; + ILoggingEvent mockEvent; + + @Before + public void setUp() throws Exception { + + mockEvent = mock(ILoggingEvent.class); + _ecompResponseCode= spy(EcompResponseCode.class); + + } + @Test + public void getDefaultCode(){ + assertEquals(_ecompResponseCode.convert(mockEvent), LoggingContext.UNKNOWN_ERROR); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/logging/EcompResponseDescriptionTest.java b/aai-core/src/test/java/org/onap/aai/logging/EcompResponseDescriptionTest.java new file mode 100644 index 00000000..3453d2de --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/logging/EcompResponseDescriptionTest.java @@ -0,0 +1,50 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.logging; + +import static org.junit.Assert.*; +import static org.mockito.Mockito.*; + +import ch.qos.logback.classic.Level; + +import ch.qos.logback.classic.spi.ILoggingEvent; +import org.junit.*; +import org.onap.aai.logging.LoggingContext.LoggingField; + +public class EcompResponseDescriptionTest { + + EcompResponseDescription _ecompResponseDescription; + ILoggingEvent mockEvent; + + @Before + public void setUp() throws Exception { + + mockEvent = mock(ILoggingEvent.class); + _ecompResponseDescription= spy(EcompResponseDescription.class); + + } + @Test + public void getDefaultDesc(){ + assertEquals(_ecompResponseDescription.convert(mockEvent), _ecompResponseDescription.DefaultDescription); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/logging/LoggingContextTest.java b/aai-core/src/test/java/org/onap/aai/logging/LoggingContextTest.java index 7885410d..46ac5997 100644 --- a/aai-core/src/test/java/org/onap/aai/logging/LoggingContextTest.java +++ b/aai-core/src/test/java/org/onap/aai/logging/LoggingContextTest.java @@ -53,7 +53,7 @@ public class LoggingContextTest { } @Test - public void testRequestId() throws Exception { //AKA Transaction ID + public void testRequestId() { //AKA Transaction ID final String sUuid = "57d51eaa-edc6-4f50-a69d-f2d4d2445120"; LoggingContext.requestId(sUuid); 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 df9d6122..968adb3c 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 @@ -126,7 +126,7 @@ public class GraphTraversalTest extends AAISetup { QueryParser query = dbEngine.getQueryBuilder().createQueryFromURI(uri); GraphTraversal expected = __.start() .has("physical-location-id", "key1").has("aai-node-type", "complex") - .out("hasCtagPool") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "ctag-pool") .has("target-pe", "key2").has("availability-zone-name", "key3"); GraphTraversal expectedParent = __.start() @@ -164,14 +164,14 @@ public class GraphTraversalTest extends AAISetup { QueryParser query = dbEngine.getQueryBuilder().createQueryFromURI(uri); GraphTraversal expected = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") - .has("interface-id", "key2").out("hasCTag") + .has("interface-id", "key2").in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "cvlan-tag") .has("cvlan-tag", 655); GraphTraversal expectedParent = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") .has("interface-id", "key2"); assertEquals( @@ -212,13 +212,13 @@ public class GraphTraversalTest extends AAISetup { QueryParser query = dbEngine.getQueryBuilder().createQueryFromURI(uri); GraphTraversal expected = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") - .has("interface-id", "key2").out("hasCTag") + .has("interface-id", "key2").in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "cvlan-tag"); GraphTraversal expectedParent = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") .has("interface-id", "key2"); assertEquals( @@ -296,7 +296,7 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("cloud-owner", "mycloudowner").has("cloud-region-id", "mycloudregionid") .has("aai-node-type", "cloud-region") - .out("has") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "tenant") .has("tenant-name", "Tenant1"); @@ -340,7 +340,7 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("cloud-owner", "mycloudowner").has("cloud-region-id", "mycloudregionid") .has("aai-node-type", "cloud-region") - .out("has") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "tenant") .has("tenant-name", P.within(values)); @@ -432,14 +432,14 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") - .has("interface-id", "key2").out("hasCTag") + .has("interface-id", "key2").in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "cvlan-tag") .has("cvlan-tag", 333); GraphTraversal expectedParent = __.start() .has("vnf-id", "key1").has("aai-node-type", "vce") - .out("hasPortGroup") + .in("org.onap.relationships.inventory.BelongsTo") .has("aai-node-type", "port-group") .has("interface-id", "key2"); assertEquals( @@ -527,7 +527,7 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("vnf-id", "key1").has(AAIProperties.NODE_TYPE, P.within("vce", "generic-vnf")) - .union(__.out("has").has(AAIProperties.NODE_TYPE, "vf-module")).has("vf-module-id", "key2"); + .union(__.in("org.onap.relationships.inventory.BelongsTo").has(AAIProperties.NODE_TYPE, "vf-module")).has("vf-module-id", "key2"); GraphTraversal expectedParent = __.start() .has("vnf-id", "key1").has(AAIProperties.NODE_TYPE, P.within("vce", "generic-vnf")); @@ -621,15 +621,15 @@ public class GraphTraversalTest extends AAISetup { @Test public void dbAliasedSearch() throws UnsupportedEncodingException, AAIException { - URI uri = UriBuilder.fromPath("network/test-objects").build(); + URI uri = UriBuilder.fromPath("network/generic-vnfs").build(); MultivaluedMap map = new MultivaluedHashMap<>(); map.putSingle("persona-model-customization-id", "key2"); QueryParser query = dbEnginev9.getQueryBuilder().createQueryFromURI(uri, map); GraphTraversal expected = __.start() - .has("aai-node-type", "test-object") + .has("aai-node-type", "generic-vnf") .has("model-customization-id", "key2"); GraphTraversal expectedParent = __.start() - .has("aai-node-type", "test-object"); + .has("aai-node-type", "generic-vnf"); assertEquals( "gremlin query should be " + expected.toString(), @@ -642,7 +642,7 @@ public class GraphTraversalTest extends AAISetup { assertEquals( "result type should be", - "test-object", + "generic-vnf", query.getResultType()); assertEquals( "result type should be empty", @@ -661,7 +661,7 @@ public class GraphTraversalTest extends AAISetup { QueryParser query = dbEnginev9.getQueryBuilder().createQueryFromURI(uri, map); GraphTraversal expected = __.start() .has("aai-node-type", "vpn-binding") - .where(__.out("has").has(AAIProperties.NODE_TYPE, "route-target").has("global-route-target", "key2")); + .where(__.in("org.onap.relationships.inventory.BelongsTo").has(AAIProperties.NODE_TYPE, "route-target").has("global-route-target", "key2")); GraphTraversal expectedParent = __.start() .has("aai-node-type", "vpn-binding"); @@ -693,7 +693,7 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("physical-location-id", "key1") .has("aai-node-type", "complex") - .in("locatedIn").has("aai-node-type", "pserver"); + .in("org.onap.relationships.inventory.LocatedIn").has("aai-node-type", "pserver"); GraphTraversal expectedParent = __.start() .has("physical-location-id", "key1") .has("aai-node-type", "complex"); @@ -727,7 +727,7 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("physical-location-id", "key1") .has("aai-node-type", "complex") - .in("locatedIn").has("aai-node-type", "pserver") + .in("org.onap.relationships.inventory.LocatedIn").has("aai-node-type", "pserver") .has("hostname", "key2"); GraphTraversal expectedParent = __.start() .has("physical-location-id", "key1") @@ -762,14 +762,14 @@ public class GraphTraversalTest extends AAISetup { GraphTraversal expected = __.start() .has("physical-location-id", "key1") .has("aai-node-type", "complex") - .in("locatedIn").has("aai-node-type", "pserver") + .in("org.onap.relationships.inventory.LocatedIn").has("aai-node-type", "pserver") .has("hostname", "key2") - .in("runsOnPserver").has("aai-node-type", "vserver") + .in("tosca.relationships.HostedOn").has("aai-node-type", "vserver") .has("vserver-id", "key3"); GraphTraversal expectedParent = __.start() .has("physical-location-id", "key1") .has("aai-node-type", "complex") - .in("locatedIn").has("aai-node-type", "pserver") + .in("org.onap.relationships.inventory.LocatedIn").has("aai-node-type", "pserver") .has("hostname", "key2"); assertEquals( diff --git a/aai-core/src/test/java/org/onap/aai/parsers/query/UniqueURIQueryTest.java b/aai-core/src/test/java/org/onap/aai/parsers/query/UniqueURIQueryTest.java index 84e9c6bc..d9dcabd3 100644 --- a/aai-core/src/test/java/org/onap/aai/parsers/query/UniqueURIQueryTest.java +++ b/aai-core/src/test/java/org/onap/aai/parsers/query/UniqueURIQueryTest.java @@ -150,7 +150,7 @@ public class UniqueURIQueryTest extends AAISetup { String parentKey = "vce/key1/port-group/key2"; URI uri = UriBuilder.fromPath(parentURI + "/cvlan-tags").build(); QueryParser query = dbEngine.getQueryBuilder().createQueryFromURI(uri); - GraphTraversal expected = __.start().has("aai-unique-key", parentKey).out("hasCTag").has("aai-node-type", "cvlan-tag"); + GraphTraversal expected = __.start().has("aai-unique-key", parentKey).in("org.onap.relationships.inventory.BelongsTo").has("aai-node-type", "cvlan-tag"); GraphTraversal parentExpected = __.start().has("aai-unique-key",parentKey); String parentResultType = "port-group"; String resultType = "cvlan-tag"; diff --git a/aai-core/src/test/java/org/onap/aai/parsers/relationship/RelationshipToURITest.java b/aai-core/src/test/java/org/onap/aai/parsers/relationship/RelationshipToURITest.java index 04727067..1710986b 100644 --- a/aai-core/src/test/java/org/onap/aai/parsers/relationship/RelationshipToURITest.java +++ b/aai-core/src/test/java/org/onap/aai/parsers/relationship/RelationshipToURITest.java @@ -54,7 +54,7 @@ public class RelationshipToURITest extends AAISetup { public void onlyLink() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("only-related-link.json")); - URI expected = new URI("/aai/v10/network/test-objects/test-object/key1"); + URI expected = new URI("/aai/v10/network/generic-vnfs/generic-vnf/key1"); RelationshipToURI parse = new RelationshipToURI(loader, obj); @@ -67,7 +67,7 @@ public class RelationshipToURITest extends AAISetup { public void onlyData() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("only-relationship-data.json")); - URI expected = new URI("/network/test-objects/test-object/key1"); + URI expected = new URI("/network/generic-vnfs/generic-vnf/key1"); RelationshipToURI parse = new RelationshipToURI(loader, obj); @@ -80,7 +80,7 @@ public class RelationshipToURITest extends AAISetup { public void failV10() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("both-failv10-successv9.json")); - URI expected = new URI("/aai/v10/network/test-objects/test-object/key1"); + URI expected = new URI("/aai/v10/network/generic-vnfs/generic-vnf/key1"); thrown.expect(AAIIdentityMapParseException.class); thrown.expect(hasProperty("code", is("AAI_3000"))); @@ -93,7 +93,7 @@ public class RelationshipToURITest extends AAISetup { public void successV9() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version9); Introspector obj = loader.unmarshal("relationship", this.getJsonString("both-failv10-successv9.json")); - URI expected = new URI("/network/test-objects/test-object/key2"); + URI expected = new URI("/network/generic-vnfs/generic-vnf/key2"); RelationshipToURI parse = new RelationshipToURI(loader, obj); URI uri = parse.getUri(); @@ -107,7 +107,7 @@ public class RelationshipToURITest extends AAISetup { public void failV9() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version9); Introspector obj = loader.unmarshal("relationship", this.getJsonString("both-successv10-failv9.json")); - URI expected = new URI("/network/test-objects/test-object/key1"); + URI expected = new URI("/network/generic-vnfs/generic-vnf/key1"); thrown.expect(AAIIdentityMapParseException.class); thrown.expect(hasProperty("code", is("AAI_3000"))); @@ -122,7 +122,7 @@ public class RelationshipToURITest extends AAISetup { public void failNothingToParse() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("nothing-to-parse.json")); - URI expected = new URI("/aai/v10/network/test-objects/test-object/key1"); + URI expected = new URI("/aai/v10/network/generic-vnfs/generic-vnf/key1"); thrown.expect(AAIIdentityMapParseException.class); thrown.expect(hasProperty("code", is("AAI_3000"))); @@ -136,7 +136,7 @@ public class RelationshipToURITest extends AAISetup { public void successV10() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("both-successv10-failv9.json")); - URI expected = new URI("/aai/v10/network/test-objects/test-object/key1"); + URI expected = new URI("/aai/v10/network/generic-vnfs/generic-vnf/key1"); RelationshipToURI parse = new RelationshipToURI(loader, obj); @@ -152,7 +152,7 @@ public class RelationshipToURITest extends AAISetup { public void ambiguousRelationship() throws AAIException, URISyntaxException, IOException { Loader loader = LoaderFactory.createLoaderForVersion(modelType, version10); Introspector obj = loader.unmarshal("relationship", this.getJsonString("ambiguous-relationship.json")); - URI expected = new URI("/aai/v10/network/test-objects/test-object/key1"); + URI expected = new URI("/aai/v10/network/generic-vnfs/generic-vnf/key1"); thrown.expect(AmbiguousMapAAIException.class); thrown.expect(hasProperty("code", is("AAI_6146"))); diff --git a/aai-core/src/test/java/org/onap/aai/parsers/uri/URIParserTest.java b/aai-core/src/test/java/org/onap/aai/parsers/uri/URIParserTest.java index bc3a684b..42d26f99 100644 --- a/aai-core/src/test/java/org/onap/aai/parsers/uri/URIParserTest.java +++ b/aai-core/src/test/java/org/onap/aai/parsers/uri/URIParserTest.java @@ -59,7 +59,7 @@ public class URIParserTest extends AAISetup { URI uri = UriBuilder.fromPath("/aai/" + loader.getVersion() + "/network/tenants/tenant/key1/vservers/vserver/key2/l-interfaces/l-interface/key3").build(); thrown.expect(AAIException.class); - thrown.expect(hasProperty("code", is("AAI_3000"))); + thrown.expect(hasProperty("code", is("AAI_3001"))); new URIToDBKey(loader, uri); } diff --git a/aai-core/src/test/java/org/onap/aai/parsers/uri/URIToExtensionInformationTest.java b/aai-core/src/test/java/org/onap/aai/parsers/uri/URIToExtensionInformationTest.java index ce4933a6..ca64ec76 100644 --- a/aai-core/src/test/java/org/onap/aai/parsers/uri/URIToExtensionInformationTest.java +++ b/aai-core/src/test/java/org/onap/aai/parsers/uri/URIToExtensionInformationTest.java @@ -53,7 +53,7 @@ public class URIToExtensionInformationTest extends AAISetup { */ @Test public void vserversV8() throws JAXBException, AAIException, IllegalArgumentException, UnsupportedEncodingException { - URI uri = UriBuilder.fromPath("/aai/" + v8Loader.getVersion() + "/cloud-infrastructure/cloud-regions/cloud-region/att-aic/AAIAIC25/tenants/tenant/key1/vservers/vserver/key2").build(); + URI uri = UriBuilder.fromPath("/aai/" + v8Loader.getVersion() + "/cloud-infrastructure/cloud-regions/cloud-region/testOwner1/testRegion1/tenants/tenant/key1/vservers/vserver/key2").build(); URIToExtensionInformation parse = new URIToExtensionInformation(v8Loader, uri); String namespace = "cloudInfrastructure"; 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 d478d608..b475a385 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 @@ -35,8 +35,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.util.BulkSet; import org.apache.tinkerpop.gremlin.structure.Edge; import org.apache.tinkerpop.gremlin.structure.Graph; import org.apache.tinkerpop.gremlin.structure.Vertex; -import org.junit.Before; -import org.junit.Test; +import org.junit.*; import org.onap.aai.AAISetup; import org.onap.aai.db.props.AAIProperties; import org.onap.aai.exceptions.AAIException; @@ -51,19 +50,33 @@ import org.onap.aai.serialization.db.exceptions.NoEdgeRuleFoundException; public abstract class QueryBuilderTestAbstraction extends AAISetup { - protected Loader loader; - protected Graph graph; + protected static Loader loader; + protected static Graph graph; protected GraphTraversalSource g; - + protected EdgeRules testEdgeRules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_TraversalQueryTest.json"); - @Before - public void configure() throws Exception { + + @BeforeClass + public static void setup() throws Exception { loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, AAIProperties.LATEST); graph = TitanFactory.build().set("storage.backend", "inmemory").open(); + } + + @Before + public void configure() throws Exception { g = graph.traversal(); } - + + @After + public void deConfigure() throws Exception { + g.tx().rollback(); + } + + @AfterClass + public static void teardown() throws Exception { + graph.close(); + } @Test public void createEdgeGVnfToVnfcTraversal() throws AAIException { @@ -77,7 +90,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals(vnfc, tQ.next()); - g.tx().rollback(); + } @Test @@ -94,7 +107,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals(logicalLink, next); - g.tx().rollback(); + } @Test @@ -111,7 +124,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals(logicalLink, next); - g.tx().rollback(); + } @Test @@ -128,7 +141,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals(logicalLink, next); - g.tx().rollback(); + } @Test @@ -147,7 +160,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 1 vertexes ", 1, list.size()); assertTrue("Has vertex on the default edge ", list.contains(vnfc1)); - g.tx().rollback(); + } @Test @@ -172,7 +185,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("2 - Has 1 vertexes ", 1, list2.size()); assertTrue("2 - traversal results in vce ", list2.contains(vce)); - g.tx().rollback(); + } @Test @@ -191,7 +204,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("1 - Has 1 vertexes ", 1, list.size()); assertTrue("1 - traversal results in vnfc ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -213,7 +226,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertTrue("Has vertex on the default edge ", list.contains(vnfc1)); assertTrue("Has vertex on the re-uses edge ", list.contains(vnfc2)); - g.tx().rollback(); + } @Test @@ -234,7 +247,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 1 vertexes ", 1, list.size()); assertTrue("Only returns the generic vnf vertex", list.contains(gvnf)); - g.tx().rollback(); + } @Test @@ -250,7 +263,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 1 vertexes ", 1, list.size()); - g.tx().rollback(); + } @Test @@ -266,7 +279,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 2, list.size()); - g.tx().rollback(); + } @Test @@ -282,7 +295,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 2, list.size()); - g.tx().rollback(); + } @Test @@ -302,7 +315,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 1, list.size()); assertTrue("result has pserver ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -322,7 +335,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 1, list.size()); assertEquals("result has pserver ",pserver, list.get(0).iterator().next()); - g.tx().rollback(); + } @Test @@ -342,7 +355,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 2, list.size()); assertTrue("result has pserver ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -362,7 +375,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { list.add(tQ.next()); assertFalse("Has next 3 ",tQ.hasNext()); assertTrue("Has all the vertexes", list.contains(v1) && list.remove(v2)); - g.tx().rollback(); + } @Test @@ -382,7 +395,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 2, list.size()); assertTrue("result has pserver ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -402,7 +415,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 vertexes ", 2, list.size()); assertTrue("result has pserver ", list.contains(complex)); - g.tx().rollback(); + } @Test @@ -421,7 +434,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("1 - Has 1 edge ", 1, list.size()); assertTrue("1 - traversal results in edge ", list.contains(e)); - g.tx().rollback(); + } @Test @@ -440,7 +453,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("1 - Has 1 edge ", 1, list1.size()); assertTrue("1 - traversal results in edge ", list1.contains(e)); - g.tx().rollback(); + } @Test @@ -461,7 +474,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertTrue("result has default edge ", list.contains(e1)); assertTrue("result has other edge ", list.contains(e2)); - g.tx().rollback(); + } @Test @@ -482,7 +495,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertTrue("result has default edge ", list.contains(e1)); assertTrue("result has other edge ", list.contains(e2)); - g.tx().rollback(); + } @Test @@ -504,7 +517,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertTrue("result has default edge ", list.contains(e1)); assertTrue("result has other edge ", list.contains(e2)); - g.tx().rollback(); + } @Test (expected = NoEdgeRuleFoundException.class) @@ -518,7 +531,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { QueryBuilder tQ = getNewEdgeTraversal(gvnf); tQ.getEdgesBetweenWithLabels(EdgeType.COUSIN, "generic-vnf", "pserver", Collections.emptyList()); - g.tx().rollback(); + } @Test @@ -538,7 +551,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 1 edges ", 1, list.size()); assertFalse("result does not have default edge ", list.contains(e1)); assertTrue("result has other edge ", list.contains(e2)); - g.tx().rollback(); + } @Test @@ -558,7 +571,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 edges ", 2, list.size()); assertTrue("result has generic-vnf-pserver-A edge ", list.contains(e1)); assertTrue("result has generic-vnf-pserver-B edge ", list.contains(e2)); - g.tx().rollback(); + } @Test (expected = NoEdgeRuleFoundException.class) @@ -571,7 +584,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { List list = tQ.toList(); - g.tx().rollback(); + } private Vertex getVertex() throws AAIException { @@ -600,7 +613,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 1 edges ", 1, list.size()); assertFalse("result does not have default edge ", list.contains(e1)); assertTrue("result has other edge ", list.contains(e2)); - g.tx().rollback(); + } @Test @@ -620,7 +633,7 @@ public abstract class QueryBuilderTestAbstraction extends AAISetup { assertEquals("Has 2 edges ", 2, list.size()); assertTrue("result has generic-vnf-pserver-A edge ", list.contains(e1)); assertTrue("result has generic-vnf-pserver-B edge ", list.contains(e2)); - g.tx().rollback(); + } protected abstract QueryBuilder getNewEdgeTraversal(Vertex v); diff --git a/aai-core/src/test/java/org/onap/aai/query/builder/SimplePathTest.java b/aai-core/src/test/java/org/onap/aai/query/builder/SimplePathTest.java index a3515ab9..4dfe2dbd 100644 --- a/aai-core/src/test/java/org/onap/aai/query/builder/SimplePathTest.java +++ b/aai-core/src/test/java/org/onap/aai/query/builder/SimplePathTest.java @@ -79,9 +79,6 @@ public class SimplePathTest extends AAISetup { Vertex lint2 = graph.addVertex(T.label, "l-interface", T.id, "11", "aai-node-type", "l-interface", "interface-name", "lint2", "is-port-mirrored", "true", "in-maint", "true", "is-ip-unnumbered", "false"); - Vertex loglink2 = graph.addVertex(T.label, "logical-link", T.id, "21", "aai-node-type", "logical-link", - "link-name", "loglink2", "in-maint", "false", "link-type", "sausage"); - Vertex lint3 = graph.addVertex(T.label, "l-interface", T.id, "12", "aai-node-type", "l-interface", "interface-name", "lint3", "is-port-mirrored", "true", "in-maint", "true", "is-ip-unnumbered", "false"); @@ -91,8 +88,7 @@ public class SimplePathTest extends AAISetup { rules.addTreeEdge(g, gvnf1, lint1); rules.addEdge(g, lint1, loglink1); rules.addEdge(g, loglink1, lint2); - rules.addEdge(g, lint2, loglink2); - rules.addEdge(g, loglink2, lint3); + rules.addEdge(g, loglink1, lint3); rules.addTreeEdge(g, gvnf2, lint3); return g; 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 41daf17f..81d42ddb 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 @@ -75,20 +75,20 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("they are equal", expected, tQ.getQuery()); - g.tx().rollback(); + } @Test public void traversalClones() throws UnsupportedEncodingException, AAIException, URISyntaxException { QueryBuilder tQ = new TraversalQuery<>(loader, g); - QueryBuilder builder = tQ.createQueryFromURI(new URI("network/test-objects/test-object/key1")).getQueryBuilder(); - GraphTraversal expected = __.start().has("vnf-id", "key1").has("aai-node-type", "test-object"); - GraphTraversal containerExpected = __.start().has("aai-node-type", "test-object"); + 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()); - g.tx().rollback(); + } @Test @@ -96,13 +96,21 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { QueryBuilder tQ = new TraversalQuery<>(loader, g); 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").has("aai-node-type", "generic-vnf").out("hasLInterface").has(AAIProperties.NODE_TYPE, "l-interface").has("interface-name", "key2"); - GraphTraversal containerExpected = __.start().has("vnf-id", "key1").has("aai-node-type", "generic-vnf").out("hasLInterface").has(AAIProperties.NODE_TYPE, "l-interface"); + GraphTraversal expected = __.start() + .has("vnf-id", "key1") + .has("aai-node-type", "generic-vnf") + .in("org.onap.relationships.inventory.BelongsTo").has(AAIProperties.NODE_TYPE, "l-interface") + .has("interface-name", "key2"); + GraphTraversal containerExpected = __.start() + .has("vnf-id", "key1") + .has("aai-node-type", "generic-vnf") + .in("org.onap.relationships.inventory.BelongsTo") + .has(AAIProperties.NODE_TYPE, "l-interface"); assertEquals("query object", expected.toString(), builder.getQuery().toString()); assertEquals("container query object", containerExpected.toString(), builder.getContainerQuery().getQuery().toString()); - g.tx().rollback(); + } @Test @@ -121,7 +129,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("Has 1 vertexes ", 1, list.size()); assertTrue("Has vertex on the default edge ", list.contains(vnfc1)); - g.tx().rollback(); + } @Test @@ -146,7 +154,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("2 - Has 1 vertexes ", 1, list2.size()); assertTrue("2 - traversal results in vce ", list2.contains(vce)); - g.tx().rollback(); + } @Test @@ -165,7 +173,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("1 - Has 1 vertexes ", 1, list.size()); assertTrue("1 - traversal results in vnfc ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -187,7 +195,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertTrue("Has vertex on the default edge ", list.contains(vnfc1)); assertTrue("Has vertex on the re-uses edge ", list.contains(vnfc2)); - g.tx().rollback(); + } @Test @@ -207,7 +215,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("Has 2 vertexes ", 2, list.size()); assertTrue("result has pserver ", list.contains(pserver)); - g.tx().rollback(); + } @Test @@ -227,7 +235,7 @@ public class TraversalQueryTest extends QueryBuilderTestAbstraction { assertEquals("Has 2 vertexes ", 2, list.size()); assertTrue("result has pserver ", list.contains(complex)); - g.tx().rollback(); + } 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 new file mode 100644 index 00000000..55fdd53d --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/rest/CloudRegionTest.java @@ -0,0 +1,76 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.rest; + +import com.jayway.jsonpath.JsonPath; +import org.junit.Before; +import org.junit.Ignore; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.onap.aai.AAIJunitRunner; +import org.onap.aai.HttpTestUtil; +import org.onap.aai.PayloadUtil; +import org.onap.aai.exceptions.AAIException; +import org.skyscreamer.jsonassert.JSONAssert; + +import javax.ws.rs.core.Response; +import java.io.IOException; + +import static org.junit.Assert.assertEquals; + +/** + * CloudRegionTest is testing if you put a cloud region with all + * 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) +public class CloudRegionTest { + + private HttpTestUtil httpTestUtil; + + @Before + public void setUp(){ + httpTestUtil = new HttpTestUtil(); + } + + @Ignore("Test is failing due to the deletion of node with children not correct will be fixed soon") + @Test + public void testPutWithAllCloudRegionChildrenNodesAndCheckIfDeleteIsSuccessful() throws IOException, AAIException { + + String cloudRegionPayload = PayloadUtil.getResourcePayload("cloud-region-with-all-children.json"); + String cloudRegionUri = "/aai/v12/cloud-infrastructure/cloud-regions/cloud-region/junit-cloud-owner/junit-cloud-region"; + + Response response = httpTestUtil.doPut(cloudRegionUri, cloudRegionPayload); + assertEquals("Expected the cloud region to be created", 201, response.getStatus()); + + response = httpTestUtil.doGet(cloudRegionUri); + assertEquals("Expected the cloud region to be found", 200, response.getStatus()); + String jsonResponse = response.getEntity().toString(); + + JSONAssert.assertEquals(cloudRegionPayload, jsonResponse, false); + String resourceVersion = JsonPath.read(jsonResponse, "$.resource-version"); + + 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 new file mode 100644 index 00000000..f42eebb8 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/rest/GenericVnfLInterfaceTest.java @@ -0,0 +1,78 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.rest; + +import org.json.JSONObject; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.onap.aai.AAIJunitRunner; +import org.onap.aai.HttpTestUtil; +import org.onap.aai.PayloadUtil; +import org.skyscreamer.jsonassert.JSONAssert; + +import javax.ws.rs.core.Response; +import java.util.HashMap; +import java.util.Map; + +import static org.junit.Assert.assertEquals; + +@RunWith(AAIJunitRunner.class) +public class GenericVnfLInterfaceTest { + + private HttpTestUtil httpTestUtil; + + @Before + public void setUp(){ + httpTestUtil = new HttpTestUtil(); + } + + @Test + public void testPutTwoLInterfacesToGenericVnf() throws Exception { + + Map templateValueMap = new HashMap<>(); + templateValueMap.put("ip-address", "ipv1"); + + String resource = PayloadUtil.getTemplatePayload("generic-vnf-with-lag-interface.json", templateValueMap); + Response response = httpTestUtil.doPut("/aai/v12/network/generic-vnfs/generic-vnf/vnf1", resource); + assertEquals("Expecting the generic vnf to be created", 201, response.getStatus()); + + 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\""); + response = httpTestUtil.doPut("/aai/v12/network/generic-vnfs/generic-vnf/vnf1", resource); + assertEquals("Expecting the generic vnf to be updated", 200, response.getStatus()); + + response = httpTestUtil.doGet("/aai/v12/network/generic-vnfs/generic-vnf/vnf1"); + assertEquals("Expecting the generic vnf to be updated", 200, response.getStatus()); + + String expected = PayloadUtil.getExpectedPayload("generic-vnf-with-lag-interface.json"); + JSONAssert.assertEquals(expected, response.getEntity().toString(), false); + + JSONObject jsonObject = new JSONObject(response.getEntity().toString()); + String resourceVersion = (String) jsonObject.get("resource-version"); + + response = httpTestUtil.doDelete("/aai/v12/network/generic-vnfs/generic-vnf/vnf1", resourceVersion); + assertEquals("Expecting the generic vnf to be deleted", 204, response.getStatus()); + } +} 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 new file mode 100644 index 00000000..3de8dfa2 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/rest/TenantTest.java @@ -0,0 +1,93 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.rest; + +import com.jayway.jsonpath.JsonPath; +import org.junit.Before; +import org.junit.Ignore; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.onap.aai.AAIJunitRunner; +import org.onap.aai.HttpTestUtil; +import org.onap.aai.PayloadUtil; +import org.skyscreamer.jsonassert.JSONAssert; + +import javax.ws.rs.core.Response; +import java.util.HashMap; +import java.util.Map; +import java.util.UUID; + +import static org.junit.Assert.assertEquals; + +@RunWith(AAIJunitRunner.class) +public class TenantTest { + + private HttpTestUtil httpTestUtil; + + private Map templateValuesMap; + + @Before + public void setup(){ + httpTestUtil = new HttpTestUtil(); + templateValuesMap = new HashMap<>(); + } + + @Ignore("Test is failing due to the deletion of node with children not correct will be fixed soon") + @Test + public void testCloudRegionTenantDeleteSuccessWithoutDeletingVserver() throws Exception { + + templateValuesMap.put("cloud-region-id", UUID.randomUUID().toString()); + templateValuesMap.put("cloud-owner", UUID.randomUUID().toString()); + templateValuesMap.put("tenant-id", UUID.randomUUID().toString()); + templateValuesMap.put("vserver-id", UUID.randomUUID().toString()); + + String cloudRegionPayload = PayloadUtil.getTemplatePayload("cloud-region.json", templateValuesMap); + String cloudRegionUri = String.format("/aai/v12/cloud-infrastructure/cloud-regions/cloud-region/%s/%s", + templateValuesMap.get("cloud-owner"), + templateValuesMap.get("cloud-region-id") + ); + + String tenantUri = cloudRegionUri + "/tenants/tenant/" + templateValuesMap.get("tenant-id"); + String tenantPayload = PayloadUtil.getTemplatePayload("tenant.json", templateValuesMap); + + Response response = httpTestUtil.doPut(cloudRegionUri, cloudRegionPayload); + assertEquals("Expected the cloud region to be created", 201, response.getStatus()); + + response = httpTestUtil.doGet(tenantUri); + assertEquals("Expected the cloud region to be created", 200, response.getStatus()); + String responseStr = response.getEntity().toString(); + + JSONAssert.assertEquals(tenantPayload, responseStr, false); + String resourceVersion = JsonPath.read(responseStr, "$.resource-version"); + + response = httpTestUtil.doDelete(tenantUri, resourceVersion); + assertEquals("Expected the cloud region to be created", 204, response.getStatus()); + + response = httpTestUtil.doGet(cloudRegionUri); + assertEquals("Expected the cloud region to be created", 200, response.getStatus()); + responseStr = response.getEntity().toString(); + resourceVersion = JsonPath.read(responseStr, "$.resource-version"); + + response = httpTestUtil.doDelete(cloudRegionUri, resourceVersion); + assertEquals("Expected the cloud region to be created", 204, response.getStatus()); + } +} 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 f643fc47..0d4f4f14 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 @@ -52,6 +52,7 @@ import com.google.gson.JsonObject; import com.google.gson.JsonParser; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; import static org.mockito.Matchers.anyObject; import static org.mockito.Mockito.when; @@ -115,6 +116,31 @@ 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 { + URI uriObject = UriBuilder.fromPath(uri).build(); + QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); + String objType = uriQuery.getResultType(); + if (uri.endsWith("relationship")) { + objType = "relationship"; + } + Introspector obj = null; + if (method.equals(HttpMethod.GET)) { + obj = loader.introspectorFromName(objType); + } else { + obj = loader.unmarshal(objType, content, org.onap.aai.restcore.MediaType.getEnum("application/json")); + } + + DBRequest dbRequest = + new DBRequest.Builder(method, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") + .rawRequestContent(content).build(); + + List dbRequestList = new ArrayList<>(); + dbRequestList.add(dbRequest); + + Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); + return responsesTuple.getValue1().get(0).getValue1(); + } + @Test public void test1PutOnPserver() throws UnsupportedEncodingException, AAIException { @@ -124,99 +150,95 @@ public class HttpEntryTest extends AAISetup { Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); - - QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); - + String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = "{\"hostname\":\"junit-test1\"}"; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + dbEngine.commit(); + assertEquals("Expected the pserver to be created", 201, response.getStatus()); + } - Introspector obj = loader.unmarshal("pserver", content, org.onap.aai.restcore.MediaType.getEnum("application/json")); - - DBRequest dbRequest = - new DBRequest.Builder(HttpMethod.PUT, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") - .rawRequestContent(content).build(); + @Test + public void test2PutOnPserverNoPInterface() throws UnsupportedEncodingException, AAIException { - List dbRequestList = new ArrayList<>(); - dbRequestList.add(dbRequest); + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); - Response response = responsesTuple.getValue1().get(0).getValue1(); + String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; + String content = "{\"hostname\":\"junit-test2\"}"; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be created", 201, response.getStatus()); } @Test - public void test2GetOnPserver() throws UnsupportedEncodingException, AAIException { - + public void test3PutOnPInterface() { + try { DBConnectionType type = DBConnectionType.REALTIME; HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, 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/p-interfaces/p-interface/p1"; + String content = "{\"interface-name\":\"p1\"}"; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.PUT, uri, content); + dbEngine.commit(); + assertEquals("Expected the p-interface to be created", 201, response.getStatus()); + } catch (UnsupportedEncodingException | AAIException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } - QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); - String content = ""; - Introspector obj = loader.introspectorFromName("pserver"); + @Test + public void test4GetOnPserver() throws UnsupportedEncodingException, AAIException { - DBRequest dbRequest = - new DBRequest.Builder(HttpMethod.GET, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") - .rawRequestContent(content).build(); + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - List dbRequestList = new ArrayList<>(); - dbRequestList.add(dbRequest); + URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); - Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); - Response response = responsesTuple.getValue1().get(0).getValue1(); + 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); dbEngine.commit(); assertEquals("Expected the pserver to be returned", 200, response.getStatus()); } @Test - public void test3MergePatchOnPserver() throws UnsupportedEncodingException, AAIException { + public void test5MergePatchOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); - - QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); - + String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = "{\"hostname\":\"junit-test1\", \"equip-type\":\"junit-equip-type\"}"; - - Introspector obj = loader.unmarshal("pserver", content, org.onap.aai.restcore.MediaType.getEnum("application/json")); - - DBRequest dbRequest = - new DBRequest.Builder(HttpMethod.MERGE_PATCH, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") - .rawRequestContent(content).build(); - - List dbRequestList = new ArrayList<>(); - dbRequestList.add(dbRequest); - - Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); - Response response = responsesTuple.getValue1().get(0).getValue1(); + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.MERGE_PATCH, uri, content); dbEngine.commit(); assertEquals("Expected the pserver to be updated", 200, response.getStatus()); } - private int doDelete(String resourceVersion) throws UnsupportedEncodingException, AAIException { + 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); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); + URI uriObject = UriBuilder.fromPath(uri).build(); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); String content = ""; - Introspector obj = loader.introspectorFromName("pserver"); + Introspector obj = loader.introspectorFromName(nodeType); DBRequest dbRequest = new DBRequest.Builder(HttpMethod.DELETE, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") @@ -232,7 +254,8 @@ public class HttpEntryTest extends AAISetup { } @Test - public void test4DeleteOnPserver() throws UnsupportedEncodingException, AAIException { + public void test6DeleteOnPserver() throws UnsupportedEncodingException, AAIException { + DBConnectionType type = DBConnectionType.REALTIME; HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); @@ -240,22 +263,31 @@ public class HttpEntryTest extends AAISetup { TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test1").build(); - - QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); - + String uri = "/cloud-infrastructure/pservers/pserver/junit-test1"; String content = ""; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + dbEngine.commit(); + String msg = response.getEntity().toString(); + JsonObject jsonObj = new JsonParser().parse(msg).getAsJsonObject(); + String resourceVersion = ""; + if ( jsonObj.isJsonObject()) { + resourceVersion = jsonObj.get("resource-version").getAsString(); + } + assertEquals("Expected the pserver to be deleted", 204, doDelete(resourceVersion, "/cloud-infrastructure/pservers/pserver/junit-test1", "pserver")); + } - Introspector obj = loader.introspectorFromName("pserver"); - - DBRequest dbRequest = - new DBRequest.Builder(HttpMethod.GET, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") - .rawRequestContent(content).build(); + @Test + public void test7DeleteOnPserverNoPinterface() throws UnsupportedEncodingException, AAIException { - List dbRequestList = new ArrayList<>(); - dbRequestList.add(dbRequest); + + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); - Response response = responsesTuple.getValue1().get(0).getValue1(); + String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; + String content = ""; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); dbEngine.commit(); String msg = response.getEntity().toString(); JsonObject jsonObj = new JsonParser().parse(msg).getAsJsonObject(); @@ -263,36 +295,79 @@ public class HttpEntryTest extends AAISetup { if ( jsonObj.isJsonObject()) { resourceVersion = jsonObj.get("resource-version").getAsString(); } - assertEquals("Expected the pserver to be deleted", 204, doDelete(resourceVersion)); + assertEquals("Expected the pserver to be deleted", 204, doDelete(resourceVersion, "/cloud-infrastructure/pservers/pserver/junit-test2", "pserver")); } + @Test - public void test5FailedGetOnPserver() throws UnsupportedEncodingException, AAIException { + public void test8FailedGetOnPserver() throws UnsupportedEncodingException, AAIException { DBConnectionType type = DBConnectionType.REALTIME; HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); Loader loader = httpEntry.getLoader(); TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - URI uriObject = UriBuilder.fromPath("/cloud-infrastructure/pservers/pserver/junit-test2").build(); + String uri = "/cloud-infrastructure/pservers/pserver/junit-test2"; + String content = ""; + Response response = getResponse(httpEntry, loader, dbEngine, HttpMethod.GET, uri, content); + dbEngine.commit(); - QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(uriObject); + assertEquals("Expected the pserver to be deleted", 404, response.getStatus()); + } - String content = ""; + @Test + public void putEdgeTest() throws UnsupportedEncodingException, AAIException { - Introspector obj = loader.introspectorFromName("pserver"); + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - DBRequest dbRequest = - new DBRequest.Builder(HttpMethod.GET, uriObject, uriQuery, obj, httpHeaders, uriInfo, "JUNIT-TRANSACTION") - .rawRequestContent(content).build(); + //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); + //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); + + //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); + + dbEngine.rollback(); + //System.out.println(response.getEntity().toString()); + assertEquals("Expected the pserver to be created", 200, response.getStatus()); + } - List dbRequestList = new ArrayList<>(); - dbRequestList.add(dbRequest); + @Test + public void putEdgeWrongLabelTest() throws UnsupportedEncodingException, AAIException { - Pair>> responsesTuple = httpEntry.process(dbRequestList, "JUNIT"); - Response response = responsesTuple.getValue1().get(0).getValue1(); - dbEngine.commit(); + DBConnectionType type = DBConnectionType.REALTIME; + HttpEntry httpEntry = new HttpEntry(Version.getLatest(), ModelType.MOXY, QueryStyle.TRAVERSAL, type); + Loader loader = httpEntry.getLoader(); + TransactionalGraphEngine dbEngine = httpEntry.getDbEngine(); - assertEquals("Expected the pserver to be deleted", 404, response.getStatus()); + //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); + //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); + + //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); + + 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")); } } 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 5fade2ed..b124e5dd 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 @@ -1,28 +1,27 @@ -/*- +/** * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright Ā© 2017 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 - * + * + * 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.serialization.db; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; @@ -30,10 +29,7 @@ import java.io.UnsupportedEncodingException; import java.lang.reflect.Field; import java.net.URI; import java.net.URISyntaxException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; +import java.util.*; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; import org.apache.tinkerpop.gremlin.structure.Edge; @@ -41,10 +37,7 @@ 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.After; -import org.junit.Before; -import org.junit.Rule; -import org.junit.Test; +import org.junit.*; import org.junit.rules.ExpectedException; import org.onap.aai.AAISetup; import org.onap.aai.db.props.AAIProperties; @@ -69,7 +62,7 @@ public class DbSerializerTest extends AAISetup { @Rule public ExpectedException thrown = ExpectedException.none(); - protected Graph graph; + protected static Graph graph; protected final EdgeRules rules = EdgeRules.getInstance(); private final Version version = Version.getLatest(); @@ -82,22 +75,27 @@ public class DbSerializerTest extends AAISetup { private DBSerializer dbser; TransactionalGraphEngine spy; TransactionalGraphEngine.Admin adminSpy; - + + @BeforeClass + public static void init() throws Exception { + graph = TitanFactory.build().set("storage.backend", "inmemory").open(); + createGraph(); + + } + @Before public void setup() throws Exception { - graph = TitanFactory.build().set("storage.backend", "inmemory").open(); loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); dbEngine = new TitanDBEngine(queryStyle, type, loader); spy = spy(dbEngine); adminSpy = spy(dbEngine.asAdmin()); - - createGraph(); + engine = new TitanDBEngine(queryStyle, type, loader); dbser = new DBSerializer(version, engine, introspectorFactoryType, "AAI-TEST"); } - public void createGraph() throws AAIException { + public static void createGraph() throws AAIException { /* * This setus up the test graph, For future junits , add more vertices * and edges @@ -115,19 +113,63 @@ public class DbSerializerTest extends AAISetup { .next(); GraphTraversalSource g = graph.traversal(); - rules.addEdge(g, l3interipv4addresslist_1, subnet_2); - rules.addEdge(g, l3interipv6addresslist_3, subnet_4); - rules.addTreeEdge(g, subnet_5, l3network_6); + 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 { + EdgeRules testRules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); + + Vertex genericVnf1 = graph.addVertex("aai-node-type", "generic-vnf", "vnf-id", "vnf1", "vnf-name", "vnfName1"); + + Vertex lInterface1 = graph.addVertex("aai-node-type", "l-interface", "interface-name", "lInterface1"); + Vertex lInterface2 = graph.addVertex("aai-node-type", "l-interface", "interface-name", "lInterface2"); + + Vertex logicalLink1 = graph.addVertex("aai-node-type", "logical-link", "link-name", "logicalLink1"); + Vertex logicalLink2 = graph.addVertex("aai-node-type", "logical-link", "link-name", "logicalLink2"); + + GraphTraversalSource g = graph.traversal(); + + testRules.addTreeEdge(g, genericVnf1, lInterface1); + testRules.addTreeEdge(g, genericVnf1, lInterface2); + testRules.addEdge(g, lInterface1, logicalLink1); + testRules.addEdge(g, lInterface1, logicalLink2); + // This line will cause the logical link2 to be found twice under linterface 1 + // and also under the linterface 2 and since in the past deletable returned + // duplicates this test checks that it shouldn't return duplicates + testRules.addEdge(g, lInterface2, logicalLink2); + + when(spy.asAdmin()).thenReturn(adminSpy); + when(adminSpy.getTraversalSource()).thenReturn(g); + when(adminSpy.getReadOnlyTraversalSource()).thenReturn(g); + + List deletableVertexes = spy.getQueryEngine().findDeletable(genericVnf1); + Set vertexSet = new HashSet<>(); + + for (Vertex deletableVertex : deletableVertexes) { + if(!vertexSet.contains(deletableVertex)){ + vertexSet.add(deletableVertex); + } else { + fail("Find deletable is returning a list of duplicate vertexes"); + } + } } @After public void tearDown() throws Exception { + engine.rollback(); + } + + @AfterClass + public static void destroy() throws Exception { graph.close(); } @Test - public void subnetDelwithInEdgesIpv4Test() throws AAIException { + public void subnetDelWithInEdgesIpv4Test() throws AAIException { 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]"; /* @@ -141,7 +183,7 @@ public class DbSerializerTest extends AAISetup { } @Test - public void subnetDelwithInEdgesIpv6Test() throws AAIException { + public void subnetDelWithInEdgesIpv6Test() throws AAIException { 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]"; /* @@ -154,7 +196,7 @@ public class DbSerializerTest extends AAISetup { } @Test - public void subnetDelwithInEdgesL3network() throws AAIException { + public void subnetDelWithInEdgesL3network() throws AAIException { String expected_message = ""; /* @@ -169,7 +211,6 @@ public class DbSerializerTest extends AAISetup { public String testDelete(Vertex v) throws AAIException { - // Graph g_tx = graph.newTransaction(); GraphTraversalSource traversal = graph.traversal(); when(spy.asAdmin()).thenReturn(adminSpy); when(adminSpy.getTraversalSource()).thenReturn(traversal); @@ -181,7 +222,6 @@ public class DbSerializerTest extends AAISetup { serializer.delete(v, "resourceVersion", false); } catch (AAIException exception) { exceptionMessage = exception.getMessage(); - } return exceptionMessage; @@ -197,7 +237,7 @@ public class DbSerializerTest extends AAISetup { Vertex fromGraph = engine.tx().traversal().V().has("aai-node-type","generic-vnf").toList().get(0); assertEquals(testVertex.id(), fromGraph.id()); assertEquals("AAI-TEST", fromGraph.property(AAIProperties.SOURCE_OF_TRUTH.toString()).value()); - engine.rollback(); + } @Test @@ -205,22 +245,38 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); DBSerializer dbser2 = new DBSerializer(Version.getLatest(), engine, introspectorFactoryType, "AAI-TEST-2"); - Graph graph = TinkerGraph.open(); Vertex vert = graph.addVertex("aai-node-type", "generic-vnf"); dbser.touchStandardVertexProperties(vert, true); - String resverStart = (String)vert.property(AAIProperties.RESOURCE_VERSION.toString()).value(); - String lastModTimeStart = (String)vert.property(AAIProperties.LAST_MOD_TS.toString()).value(); + String resverStart = (String)vert.property(AAIProperties.RESOURCE_VERSION).value(); + String lastModTimeStart = (String)vert.property(AAIProperties.LAST_MOD_TS).value(); Thread.sleep(10); //bc the resource version is set based on current time in milliseconds, //if this test runs through too fast the value may not change //causing the test to fail. sleeping ensures a different value dbser2.touchStandardVertexProperties(vert, false); - assertFalse(resverStart.equals((String)vert.property(AAIProperties.RESOURCE_VERSION.toString()).value())); - assertFalse(lastModTimeStart.equals((String)vert.property(AAIProperties.LAST_MOD_TS.toString()).value())); - assertEquals("AAI-TEST-2", (String)vert.property(AAIProperties.LAST_MOD_SOURCE_OF_TRUTH.toString()).value()); - engine.rollback(); + assertFalse(resverStart.equals(vert.property(AAIProperties.RESOURCE_VERSION).value())); + assertFalse(lastModTimeStart.equals(vert.property(AAIProperties.LAST_MOD_TS).value())); + assertEquals("AAI-TEST-2", vert.property(AAIProperties.LAST_MOD_SOURCE_OF_TRUTH).value()); + + } + + @Test + public void touchStandardVertexPropertiesAAIUUIDTest() throws AAIException, InterruptedException { + engine.startTransaction(); + + Graph graph = TinkerGraph.open(); + Vertex v = graph.addVertex("aai-node-type", "generic-vnf"); + + dbser.touchStandardVertexProperties(v, true); + + assertTrue(v.property(AAIProperties.AAI_UUID).isPresent()); + try { + UUID.fromString((String)v.property(AAIProperties.AAI_UUID).value()); + } catch (IllegalArgumentException e) { + fail("Vertex uuid is not valid uuid"); + } } @Test @@ -228,7 +284,7 @@ public class DbSerializerTest extends AAISetup { engine.startTransaction(); assertTrue(dbser.verifyResourceVersion("delete", "vnfc", "abc", "abc", "vnfcs/vnfc/vnfcId")); - engine.rollback(); + } @Test @@ -237,11 +293,8 @@ public class DbSerializerTest extends AAISetup { thrown.expect(AAIException.class); thrown.expectMessage("resource-version passed for create of generic-vnfs/generic-vnf/myid"); - try { - dbser.verifyResourceVersion("create", "generic-vnf", null, "old-res-ver", "generic-vnfs/generic-vnf/myid"); - } finally { - engine.rollback(); - } + dbser.verifyResourceVersion("create", "generic-vnf", null, "old-res-ver", "generic-vnfs/generic-vnf/myid"); + } @Test @@ -250,11 +303,8 @@ public class DbSerializerTest extends AAISetup { thrown.expect(AAIException.class); thrown.expectMessage("resource-version not passed for update of generic-vnfs/generic-vnf/myid"); - try { - dbser.verifyResourceVersion("update", "generic-vnf", "current-res-ver", null, "generic-vnfs/generic-vnf/myid"); - } finally { - engine.rollback(); - } + dbser.verifyResourceVersion("update", "generic-vnf", "current-res-ver", null, "generic-vnfs/generic-vnf/myid"); + } @Test @@ -263,11 +313,8 @@ public class DbSerializerTest extends AAISetup { thrown.expect(AAIException.class); thrown.expectMessage("resource-version MISMATCH for update of generic-vnfs/generic-vnf/myid"); - try { - dbser.verifyResourceVersion("update", "generic-vnf", "current-res-ver", "old-res-ver", "generic-vnfs/generic-vnf/myid"); - } finally { - engine.rollback(); - } + dbser.verifyResourceVersion("update", "generic-vnf", "current-res-ver", "old-res-ver", "generic-vnfs/generic-vnf/myid"); + } @Test @@ -291,7 +338,7 @@ public class DbSerializerTest extends AAISetup { cr.property("aai-node-type").remove(); URI compareFailure = new URI("/unknown-uri"); assertEquals(compareFailure, dbser.getURIForVertex(ten)); - engine.rollback(); + } @Test @@ -304,7 +351,7 @@ public class DbSerializerTest extends AAISetup { assertEquals("cloud-region", crIntro.getDbName()); assertEquals("me", crIntro.getValue("cloud-owner")); assertEquals("123", crIntro.getValue("cloud-region-id")); - engine.rollback(); + } @Test @@ -334,7 +381,7 @@ public class DbSerializerTest extends AAISetup { (String)ten.property(AAIProperties.AAI_URI.toString()).value()); assertEquals("/cloud-infrastructure/cloud-regions/cloud-region/me/123/tenants/tenant/453/vservers/vserver/vs1", (String)vs.property(AAIProperties.AAI_URI.toString()).value()); - engine.rollback(); + } @Test @@ -347,8 +394,8 @@ public class DbSerializerTest extends AAISetup { rules.addTreeEdge(engine.tx().traversal(), cr, ten); Edge e = dbser.getEdgeBetween(EdgeType.TREE, ten, cr, null); - assertEquals("has", e.label()); - engine.rollback(); + assertEquals("org.onap.relationships.inventory.BelongsTo", e.label()); + } @Test @@ -372,7 +419,7 @@ public class DbSerializerTest extends AAISetup { assertFalse(engine.tx().traversal().V(gvnf).both("uses").hasNext()); assertFalse(engine.tx().traversal().V(vnfc).both("uses").hasNext()); - engine.rollback(); + } @Test @@ -392,11 +439,11 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("relationship-data",relData); assertTrue(dbser.createEdge(relationship, gvnf)); - assertTrue(engine.tx().traversal().V(gvnf).both("uses").hasNext()); - assertTrue(engine.tx().traversal().V(vnfc).both("uses").hasNext()); - engine.rollback(); + assertTrue(engine.tx().traversal().V(gvnf).both("org.onap.relationships.inventory.BelongsTo").hasNext()); + assertTrue(engine.tx().traversal().V(vnfc).both("org.onap.relationships.inventory.BelongsTo").hasNext()); + } - + @Test public void createCousinEdgeThatShouldBeTreeTest() throws AAIException, UnsupportedEncodingException, URISyntaxException { engine.startTransaction(); @@ -405,31 +452,27 @@ public class DbSerializerTest extends AAISetup { Vertex vf = engine.tx().addVertex("aai-node-type","vf-module","vf-module-id","vf-id"); EdgeRules.getInstance().addTreeEdge(engine.tx().traversal(), gvnf, vf); - + Introspector relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vf-module"); relationship.setValue("related-link", dbser.getURIForVertex(vf).toString()); - //relationship.setValue("relationship-label", ""); Introspector relationshipList = loader.introspectorFromName("relationship-list"); relationshipList.setValue("relationship", Collections.singletonList(relationship.getUnderlyingObject())); - + Introspector gvnfObj = loader.introspectorFromName("generic-vnf"); Vertex gvnf2 = dbser.createNewVertex(gvnfObj); gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); gvnfObj.setValue("vnf-id", "myvnf-1"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf-1")); - + try { dbser.serializeToDb(gvnfObj, gvnf2, uriQuery, null, "test"); } catch (AAIException e) { assertEquals("AAI_6145", e.getCode()); - } - finally { - engine.rollback(); } } - + @Test public void createEdgeNodeDoesNotExistExceptionTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); @@ -447,11 +490,8 @@ public class DbSerializerTest extends AAISetup { thrown.expect(AAIException.class); thrown.expectMessage("Node of type vnfc. Could not find object at: /network/vnfcs/vnfc/b-name"); - try { - dbser.createEdge(relationship, gvnf); - } finally { - engine.rollback(); - } + dbser.createEdge(relationship, gvnf); + } @Test @@ -464,7 +504,7 @@ public class DbSerializerTest extends AAISetup { gvnf.setValue("vnf-id", "myvnf"); dbser.serializeSingleVertex(gvnfVert, gvnf, "test"); assertTrue(engine.tx().traversal().V().has("aai-node-type","generic-vnf").has("vnf-id","myvnf").hasNext()); - engine.rollback(); + } @Test @@ -483,10 +523,10 @@ public class DbSerializerTest extends AAISetup { dbser.serializeSingleVertex(ten, tenIn, "test"); assertTrue(engine.tx().traversal().V().has("aai-node-type","tenant").has("tenant-id","453").has("tenant-name","mytenant").hasNext()); - engine.rollback(); + } - - + + @Test public void getVertexPropertiesRelationshipHasLabelTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); @@ -495,15 +535,21 @@ public class DbSerializerTest extends AAISetup { Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","vnfc-123"); EdgeRules rules = EdgeRules.getInstance(); rules.addEdge(engine.tx().traversal(), gvnf, vnfc); - + Introspector obj = loader.introspectorFromName("generic-vnf"); obj = this.dbser.dbToObject(Arrays.asList(gvnf), obj, AAIProperties.MAXIMUM_DEPTH, false, "false"); - - assertEquals("edge label between generic-vnf and vnfs is uses", "uses", obj.getWrappedValue("relationship-list").getWrappedListValue("relationship").get(0).getValue("relationship-label")); - - engine.rollback(); + + assertEquals("edge label between generic-vnf and vnfs is uses", + "org.onap.relationships.inventory.BelongsTo", + obj.getWrappedValue("relationship-list") + .getWrappedListValue("relationship") + .get(0) + .getValue("relationship-label") + ); + + } - + @Test public void getVertexPropertiesRelationshipOldVersionNoEdgeLabelTest() throws AAIException, UnsupportedEncodingException { @@ -512,7 +558,7 @@ public class DbSerializerTest extends AAISetup { Loader loader = LoaderFactory.createLoaderForVersion(introspectorFactoryType, version); engine.startTransaction(); - + Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","vnf-123"); Vertex vnfc = engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","vnfc-123"); EdgeRules rules = EdgeRules.getInstance(); @@ -520,19 +566,19 @@ public class DbSerializerTest extends AAISetup { Introspector obj = loader.introspectorFromName("generic-vnf"); obj = dbser.dbToObject(Arrays.asList(gvnf), obj, AAIProperties.MAXIMUM_DEPTH, false, "false"); - + assertEquals("Relationship does not contain edge-property", false, obj.getWrappedValue("relationship-list").getWrappedListValue("relationship").get(0).hasProperty("relationship-label")); - - engine.rollback(); + + } - + @Test public void createEdgeWithValidLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); - + DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -547,16 +593,16 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); relationship.setValue("relationship-label", "over-uses"); - + assertTrue(localDbser.createEdge(relationship, gvnf)); assertTrue(engine.tx().traversal().V(gvnf).both("over-uses").hasNext()); assertTrue(engine.tx().traversal().V(vnfc).both("over-uses").hasNext()); - engine.rollback(); + } - + @Test public void createEdgeWithInvalidLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -573,20 +619,17 @@ public class DbSerializerTest extends AAISetup { thrown.expect(AAIException.class); thrown.expectMessage("no COUSIN edge rule between generic-vnf and vnfc with label NA"); - try { - dbser.createEdge(relationship, gvnf); - } finally { - engine.rollback(); - } + dbser.createEdge(relationship, gvnf); + } - + @Test public void createEdgeWithValidLabelWhenSameEdgeExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); - + DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -601,20 +644,20 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); relationship.setValue("relationship-label", "re-uses"); - + assertTrue(localDbser.createEdge(relationship, gvnf)); assertTrue(engine.tx().traversal().V(gvnf).both("re-uses").hasNext()); assertTrue(engine.tx().traversal().V(vnfc).both("re-uses").hasNext()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V(vnfc).both().count().next()); - engine.rollback(); + } - + @Test public void createEdgeWithValidLabelWhenDiffEdgeExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -630,9 +673,9 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("relationship-data",relData); relationship.setValue("relationship-label", "uses"); localDbser.createEdge(relationship, gvnf); - + relationship.setValue("relationship-label", "re-uses"); - + assertTrue(localDbser.createEdge(relationship, gvnf)); assertTrue(engine.tx().traversal().V(gvnf).both("re-uses").hasNext()); assertTrue(engine.tx().traversal().V(vnfc).both("re-uses").hasNext()); @@ -640,15 +683,15 @@ public class DbSerializerTest extends AAISetup { assertTrue(engine.tx().traversal().V(vnfc).both("uses").hasNext()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(vnfc).both().count().next()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(gvnf).both().count().next()); - engine.rollback(); + } - + @Test public void createEdgeWithNoLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -662,23 +705,23 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); localDbser.createEdge(relationship, gvnf); - + assertTrue(localDbser.createEdge(relationship, gvnf)); assertTrue(engine.tx().traversal().V(gvnf).both("uses").hasNext()); assertTrue(engine.tx().traversal().V(vnfc).both("uses").hasNext()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V(vnfc).both().count().next()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V(gvnf).both().count().next()); - engine.rollback(); + } - + @Test public void deleteEdgeWithNoLabelWhenMultipleExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); - + DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -694,7 +737,7 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-to", "vnfc"); relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); - + assertTrue(localDbser.deleteEdge(relationship, gvnf)); assertFalse("generic-vnf has no edge uses", engine.tx().traversal().V(gvnf).both("uses").hasNext()); assertFalse("vnfc has no edge uses", engine.tx().traversal().V(vnfc).both("uses").hasNext()); @@ -704,15 +747,15 @@ public class DbSerializerTest extends AAISetup { assertTrue("vnfc has edge re-uses", engine.tx().traversal().V(vnfc).both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(vnfc).both().count().next()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(gvnf).both().count().next()); - engine.rollback(); + } - + @Test public void deleteEdgeWithValidLabelWhenMultipleExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -729,7 +772,7 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); relationship.setValue("relationship-label", "re-uses"); - + assertTrue(localDbser.deleteEdge(relationship, gvnf)); assertTrue("generic-vnf has edge uses", engine.tx().traversal().V(gvnf).both("uses").hasNext()); assertTrue("vnfc has edge uses", engine.tx().traversal().V(vnfc).both("uses").hasNext()); @@ -739,15 +782,15 @@ public class DbSerializerTest extends AAISetup { assertTrue("vnfc has edge re-uses", engine.tx().traversal().V(vnfc).both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(vnfc).both().count().next()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V(gvnf).both().count().next()); - engine.rollback(); + } - + @Test public void deleteEdgeWithValidInvalidLabelWhenMultipleExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); Vertex gvnf = engine.tx().addVertex("aai-node-type","generic-vnf","vnf-id","myvnf"); @@ -764,24 +807,20 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); relationship.setValue("relationship-data",relData); relationship.setValue("relationship-label", "NA"); - + thrown.expect(AAIException.class); thrown.expectMessage("no COUSIN edge rule between generic-vnf and vnfc with label NA"); - try { - localDbser.deleteEdge(relationship, gvnf); - } finally { - engine.rollback(); - } + localDbser.deleteEdge(relationship, gvnf); } - + @Test public void serializeToDbWithLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); - + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); Introspector relationship = loader.introspectorFromName("relationship"); @@ -790,16 +829,16 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("relationship-label", "re-uses"); 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", "myvnf"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf")); - + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + assertTrue("vertex with vnf-id myvnf exists", engine.tx().traversal().V().has("vnf-id", "myvnf").hasNext()); assertTrue("vertex with vnfc-name a-name exists", engine.tx().traversal().V().has("vnfc-name", "a-name").hasNext()); assertFalse("generic-vnf has no edge re-uses", engine.tx().traversal().V().has("vnf-id", "myvnf").both("uses").hasNext()); @@ -810,17 +849,17 @@ public class DbSerializerTest extends AAISetup { assertFalse("vnfc has no edge re-uses", engine.tx().traversal().V().has("vnfc-name", "a-name").both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnfc-name", "a-name").both().count().next()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnf-id", "myvnf").both().count().next()); - engine.rollback(); + } - + @Test public void serializeToDbWithoutLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); - + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); Introspector relationship = loader.introspectorFromName("relationship"); @@ -829,16 +868,16 @@ public class DbSerializerTest extends AAISetup { 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", "myvnf"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf")); - + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + assertTrue("vertex with vnf-id myvnf exists", engine.tx().traversal().V().has("vnf-id", "myvnf").hasNext()); assertTrue("vertex with vnfc-name a-name exists", engine.tx().traversal().V().has("vnfc-name", "a-name").hasNext()); assertTrue("generic-vnf has edge uses", engine.tx().traversal().V().has("vnf-id", "myvnf").both("uses").hasNext()); @@ -849,17 +888,17 @@ public class DbSerializerTest extends AAISetup { assertFalse("vnfc has no edge over-uses", engine.tx().traversal().V().has("vnfc-name", "a-name").both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnfc-name", "a-name").both().count().next()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnf-id", "myvnf").both().count().next()); - engine.rollback(); + } - + @Test public void serializeToDbWithInvalidLabelTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); - + engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); Introspector relationship = loader.introspectorFromName("relationship"); @@ -868,33 +907,29 @@ public class DbSerializerTest extends AAISetup { relationship.setValue("relationship-label", "NA"); 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", "myvnf"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf")); - + thrown.expect(AAIException.class); thrown.expectMessage("No EdgeRule found for passed nodeTypes: generic-vnf, vnfc with label NA."); - try { - localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - } finally { - engine.rollback(); - } - engine.rollback(); + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); + } - + @Test public void serializeToDbWithLabelAndEdgeExistsTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); - + Introspector relationship; Introspector relationshipList; List relList = new ArrayList<>(); @@ -905,7 +940,7 @@ public class DbSerializerTest extends AAISetup { gvnfObj.setValue("vnf-id", "myvnf"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf")); - // create relationship to vnfc + // create relationship to vnfc relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); @@ -913,10 +948,10 @@ public class DbSerializerTest extends AAISetup { relationshipList = loader.introspectorFromName("relationship-list"); relationshipList.setValue("relationship", relList); gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); - + // add gvnf to graph localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + // add second relationship relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); @@ -926,9 +961,9 @@ public class DbSerializerTest extends AAISetup { relationshipList = loader.introspectorFromName("relationship-list"); relationshipList.setValue("relationship", relList); gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); - + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + assertTrue("vertex with vnf-id myvnf exists", engine.tx().traversal().V().has("vnf-id", "myvnf").hasNext()); assertTrue("vertex with vnfc-name a-name exists", engine.tx().traversal().V().has("vnfc-name", "a-name").hasNext()); assertTrue("generic-vnf has edge uses", engine.tx().traversal().V().has("vnf-id", "myvnf").both("uses").hasNext()); @@ -939,18 +974,18 @@ public class DbSerializerTest extends AAISetup { assertFalse("vnfc has no edge over-uses", engine.tx().traversal().V().has("vnfc-name", "a-name").both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V().has("vnfc-name", "a-name").both().count().next()); assertEquals("Number of edges between vertexes is 2", Long.valueOf(2), engine.tx().traversal().V().has("vnf-id", "myvnf").both().count().next()); - engine.rollback(); + } - + @Test public void serializeToDbWithLabelDroppingRelationshipTest() throws AAIException, UnsupportedEncodingException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, URISyntaxException { - + EdgeRules ers = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); DBSerializer localDbser = getDBSerializerWithSpecificEdgeRules(ers); - + engine.startTransaction(); engine.tx().addVertex("aai-node-type","vnfc","vnfc-name","a-name"); - + Introspector relationship; Introspector relationshipList; List relList = new ArrayList<>(); @@ -961,7 +996,7 @@ public class DbSerializerTest extends AAISetup { gvnfObj.setValue("vnf-id", "myvnf"); QueryParser uriQuery = dbEngine.getQueryBuilder().createQueryFromURI(new URI("/network/generic-vnfs/generic-vnf/myvnf")); - // create relationship to vnfc + // create relationship to vnfc relationship = loader.introspectorFromName("relationship"); relationship.setValue("related-to", "vnfc"); relationship.setValue("related-link", "/network/vnfcs/vnfc/a-name"); @@ -975,18 +1010,18 @@ public class DbSerializerTest extends AAISetup { relationshipList = loader.introspectorFromName("relationship-list"); relationshipList.setValue("relationship", relList); gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); - + // add gvnf to graph localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + // drop second relationship relList.remove(1); relationshipList = loader.introspectorFromName("relationship-list"); relationshipList.setValue("relationship", relList); gvnfObj.setValue("relationship-list", relationshipList.getUnderlyingObject()); - + localDbser.serializeToDb(gvnfObj, gvnf, uriQuery, null, "test"); - + assertTrue("vertex with vnf-id myvnf exists", engine.tx().traversal().V().has("vnf-id", "myvnf").hasNext()); assertTrue("vertex with vnfc-name a-name exists", engine.tx().traversal().V().has("vnfc-name", "a-name").hasNext()); assertTrue("generic-vnf has edge uses", engine.tx().traversal().V().has("vnf-id", "myvnf").both("uses").hasNext()); @@ -997,7 +1032,7 @@ public class DbSerializerTest extends AAISetup { assertFalse("vnfc has no edge over-uses", engine.tx().traversal().V().has("vnfc-name", "a-name").both("over-uses").hasNext()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnfc-name", "a-name").both().count().next()); assertEquals("Number of edges between vertexes is 1", Long.valueOf(1), engine.tx().traversal().V().has("vnf-id", "myvnf").both().count().next()); - engine.rollback(); + } private DBSerializer getDBSerializerWithSpecificEdgeRules(EdgeRules ers) @@ -1016,9 +1051,9 @@ public class DbSerializerTest extends AAISetup { Introspector gv = loader.introspectorFromName("generic-vnf"); gv.setValue("vnf-name", "myname"); Introspector rel = loader.introspectorFromName("relationship"); - DBSerializer dbser = new DBSerializer(Version.v11, dbEngine, + DBSerializer dbser = new DBSerializer(Version.v11, dbEngine, ModelType.MOXY, "AAI-TEST"); - + dbser.addRelatedToProperty(rel, gv); List relToProps = rel.getWrappedListValue("related-to-property"); assertTrue(relToProps.size() == 1); @@ -1026,40 +1061,40 @@ public class DbSerializerTest extends AAISetup { assertTrue("generic-vnf.vnf-name".equals(relToProp.getValue("property-key"))); assertTrue("myname".equals(relToProp.getValue("property-value"))); } - + @Test public void dbToObjectContainerMismatchTest() throws AAIException, UnsupportedEncodingException { - DBSerializer dbser = new DBSerializer(Version.v11, dbEngine, + DBSerializer dbser = new DBSerializer(Version.v11, dbEngine, ModelType.MOXY, "AAI-TEST"); - + Graph vertexMaker = TinkerGraph.open(); Vertex a = vertexMaker.addVertex(T.id, "0"); Vertex b = vertexMaker.addVertex(T.id, "1"); List vertices = Arrays.asList(a,b); - + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); Introspector intro = loader.introspectorFromName("image"); //just need any non-container object - + thrown.expect(AAIException.class); thrown.expectMessage("query object mismatch: this object cannot hold multiple items."); - + dbser.dbToObject(vertices, intro, Integer.MAX_VALUE, true, "doesn't matter"); } - + @Test public void dbToObjectTest() throws AAIException, UnsupportedEncodingException { engine.startTransaction(); - - DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, + + DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, ModelType.MOXY, "AAI-TEST"); - + Vertex gv1 = engine.tx().addVertex("aai-node-type", "generic-vnf", "vnf-id", "id1"); Vertex gv2 = engine.tx().addVertex("aai-node-type", "generic-vnf", "vnf-id", "id2"); List vertices = Arrays.asList(gv1, gv2); - + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.getLatest()); Introspector gvContainer = loader.introspectorFromName("generic-vnfs"); - + Introspector res = dbser.dbToObject(vertices, gvContainer, 0, true, "true"); List gvs = res.getWrappedListValue("generic-vnf"); assertTrue(gvs.size() == 2); @@ -1067,75 +1102,75 @@ public class DbSerializerTest extends AAISetup { String vnfId = i.getValue("vnf-id"); assertTrue("id1".equals(vnfId) || "id2".equals(vnfId)); } - - engine.rollback(); + + } - + @Test public void getEdgeBetweenNoLabelTest() throws AAIException { - DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, + DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, 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"); rules.addTreeEdge(engine.tx().traversal(), gv, lint); - + Edge res = dbser.getEdgeBetween(EdgeType.TREE, gv, lint); - assertTrue("hasLInterface".equals(res.label())); - engine.rollback(); + assertEquals("org.onap.relationships.inventory.BelongsTo", res.label()); + } @Test public void deleteItemsWithTraversal() throws AAIException { - DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, + DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, 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"); - + assertTrue(engine.tx().traversal().V().has("vnf-id", "id1").hasNext()); assertTrue(engine.tx().traversal().V().has("interface-name", "name1").hasNext()); - + dbser.deleteItemsWithTraversal(Arrays.asList(gv, lint)); - + assertTrue(!engine.tx().traversal().V().has("vnf-id", "id1").hasNext()); assertTrue(!engine.tx().traversal().V().has("interface-name", "name1").hasNext()); - - engine.rollback(); + + } - + @Test public void serializeToDbWithParentTest() throws AAIException, UnsupportedEncodingException, URISyntaxException { - DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, + DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, 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"); rules.addTreeEdge(engine.tx().traversal(), gv, lint); - + Introspector lintIntro = loader.introspectorFromName("l-interface"); 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); dbser.serializeToDb(lintIntro, lint, uriQuery, "test-identifier", "AAI-TEST"); - + assertTrue(engine.tx().traversal().V(lint).has("interface-role", "actor").hasNext()); - - engine.rollback(); + + } - + @Test public void getLatestVersionViewTest() throws AAIException, UnsupportedEncodingException { - DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, + DBSerializer dbser = new DBSerializer(Version.getLatest(), engine, ModelType.MOXY, "AAI-TEST"); - + engine.startTransaction(); - Vertex phys = engine.tx().addVertex("aai-node-type", "physical-link", "link-name", "zaldo", + Vertex phys = engine.tx().addVertex("aai-node-type", "physical-link", "link-name", "zaldo", "speed-value", "very-fast", "service-provider-bandwidth-up-units", "things"); - + Introspector res = dbser.getLatestVersionView(phys); assertTrue("zaldo".equals(res.getValue("link-name"))); assertTrue("very-fast".equals(res.getValue("speed-value"))); 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 bc6a721f..773b9cd2 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 @@ -22,9 +22,10 @@ package org.onap.aai.serialization.db; -import org.apache.tinkerpop.gremlin.structure.Direction; +import org.apache.tinkerpop.gremlin.structure.*; import org.junit.Test; import org.onap.aai.AAISetup; + import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; @@ -34,13 +35,11 @@ import java.util.Map; import java.util.Set; 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.Rule; import org.junit.rules.ExpectedException; +import org.onap.aai.db.props.AAIProperties; import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.Version; import org.onap.aai.serialization.db.exceptions.EdgeMultiplicityException; @@ -61,7 +60,7 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.TREE, "cloud-region", "flavor"); - assertEquals("out direction", rule.getDirection(), Direction.OUT); + assertEquals("out direction", rule.getDirection(), Direction.IN); } @Test @@ -69,7 +68,7 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.TREE, "flavor", "cloud-region"); - assertEquals("in direction", rule.getDirection(), Direction.IN); + assertEquals("in direction", rule.getDirection(), Direction.OUT); } @Test @@ -77,7 +76,7 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "model-ver", "model-element"); - assertEquals("in direction", rule.getDirection(), Direction.IN); + assertEquals("in direction", Direction.IN, rule.getDirection()); } @Test @@ -85,21 +84,25 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "model-element", "model-ver"); - assertEquals("out direction", rule.getDirection(), Direction.OUT); + assertEquals("out direction", Direction.OUT, rule.getDirection()); } @Test public void verifyMultipleGet() throws AAIException { EdgeRules rules = EdgeRules.getInstance(); Map ruleMap = rules.getEdgeRules("model-element", "model-ver"); - assertEquals("has isA rule", "isA", ruleMap.get("isA").getLabel()); - assertEquals("has startsWith rule", "startsWith", ruleMap.get("startsWith").getLabel()); + assertEquals("has isA rule", "org.onap.relationships.inventory.IsA", + ruleMap.get("org.onap.relationships.inventory.IsA").getLabel()); + assertEquals("has startsWith rule", "org.onap.relationships.inventory.BelongsTo", + ruleMap.get("org.onap.relationships.inventory.BelongsTo").getLabel()); } @Test public void verifyMultipleGetSingleRule() throws AAIException { EdgeRules rules = EdgeRules.getInstance(); Map ruleMap = rules.getEdgeRules("availability-zone", "complex"); - assertEquals("has groupsResourcesIn rule", "groupsResourcesIn", ruleMap.get("groupsResourcesIn").getLabel()); + + assertEquals("has org.onap.relationships.inventory.LocatedIn rule", "org.onap.relationships.inventory.LocatedIn", + ruleMap.get("org.onap.relationships.inventory.LocatedIn").getLabel()); } @Test @@ -116,7 +119,7 @@ public class EdgeRulesTest extends AAISetup { assertEquals("true: pserver | complex", true, EdgeRules.getInstance().hasEdgeRule("pserver", "complex")); assertEquals("false: pserver | service", false, EdgeRules.getInstance().hasEdgeRule("pserver", "service")); } - + @Test public void hasTreeEdgeRuleTest() { assertEquals("true: cloud-region | tenant", true, EdgeRules.getInstance().hasTreeEdgeRule("cloud-region", "tenant")); @@ -125,7 +128,7 @@ public class EdgeRulesTest extends AAISetup { assertEquals("true: service-instance | allotted-resource", true, EdgeRules.getInstance().hasTreeEdgeRule("service-instance", "allotted-resource")); } - + @Test public void hasCousinEdgeRuleTest() { assertEquals("false: cloud-region | tenant", false, EdgeRules.getInstance().hasCousinEdgeRule("cloud-region", "tenant", null)); @@ -133,11 +136,11 @@ public class EdgeRulesTest extends AAISetup { assertEquals("true: pserver | complex", true, EdgeRules.getInstance().hasCousinEdgeRule("pserver", "complex", null)); assertEquals("true: service-instance | allotted-resource", true, EdgeRules.getInstance().hasCousinEdgeRule("service-instance", "allotted-resource", null)); assertEquals("true: logical-link | l-interface", true, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", null)); - assertEquals("true: logical-link | l-interface : sourceLInterface", true, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", "sourceLInterface")); - assertEquals("true: logical-link | l-interface : targetLInterface", true, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", "targetLInterface")); + assertEquals("true: logical-link | l-interface : sourceLInterface", true, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", "org.onap.relationships.inventory.Source")); + assertEquals("true: logical-link | l-interface : targetLInterface", true, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", "org.onap.relationships.inventory.Destination")); assertEquals("false: logical-link | l-interface : blah", false, EdgeRules.getInstance().hasCousinEdgeRule("logical-link", "l-interface", "blah")); } - + @Test public void hasEdgeRuleVertexTest() { Graph graph = TinkerGraph.open(); @@ -153,11 +156,11 @@ public class EdgeRulesTest extends AAISetup { Vertex v2 = graph.addVertex("aai-node-type", "tenant"); EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.TREE, v1, v2); - assertEquals(true, "OUT".equalsIgnoreCase(rule.getContains())); - assertEquals(true, "OUT".equalsIgnoreCase(rule.getDeleteOtherV())); - assertEquals(true, MultiplicityRule.ONE2MANY.equals(rule.getMultiplicityRule())); - assertEquals(true, "IN".equalsIgnoreCase(rule.getServiceInfrastructure())); - assertEquals(true, "OUT".equalsIgnoreCase(rule.getPreventDelete())); + 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())); } @Test @@ -168,7 +171,7 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(); GraphTraversalSource g = graph.traversal(); rules.addTreeEdge(g, v1, v2); - assertEquals(true, g.V(v1).out("has").has("aai-node-type", "tenant").hasNext()); + assertEquals(true, g.V(v1).in("org.onap.relationships.inventory.BelongsTo").has("aai-node-type", "tenant").hasNext()); Vertex v3 = graph.addVertex(T.id, "2", "aai-node-type", "cloud-region"); assertEquals(null, rules.addTreeEdgeIfPossible(g, v3, v2)); @@ -182,7 +185,7 @@ public class EdgeRulesTest extends AAISetup { EdgeRules rules = EdgeRules.getInstance(Version.getLatest()); GraphTraversalSource g = graph.traversal(); rules.addEdge(g, v1, v2); - assertEquals(true, g.V(v2).out("hasFlavor").has("aai-node-type", "flavor").hasNext()); + assertEquals(true, g.V(v2).out("org.onap.relationships.inventory.Uses").has("aai-node-type", "flavor").hasNext()); Vertex v3 = graph.addVertex(T.id, "2", "aai-node-type", "flavor"); assertEquals(null, rules.addEdgeIfPossible(g, v3, v2)); @@ -191,7 +194,7 @@ public class EdgeRulesTest extends AAISetup { @Test public void multiplicityViolationTest() throws AAIException { thrown.expect(EdgeMultiplicityException.class); - thrown.expectMessage("multiplicity rule violated: only one edge can exist with label: uses between vf-module and volume-group"); + thrown.expectMessage("multiplicity rule violated: only one edge can exist with label: org.onap.relationships.inventory.Uses between vf-module and volume-group"); Graph graph = TinkerGraph.open(); Vertex v1 = graph.addVertex(T.id, "1", "aai-node-type", "vf-module"); @@ -225,7 +228,7 @@ public class EdgeRulesTest extends AAISetup { public void getAllRulesTest() { EdgeRules rules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json"); Multimap allRules = rules.getAllRules(); - assertEquals(14, allRules.size()); + assertEquals(16, allRules.size()); assertEquals(true, allRules.containsKey("foo|bar")); assertEquals(true, allRules.containsKey("foo|bar")); assertEquals(true, allRules.containsKey("quux|foo")); @@ -263,6 +266,15 @@ public class EdgeRulesTest extends AAISetup { // so if any required properties are missing, the verification builds // will catch it and incorrect rules can't get merged in. for (Version v : Version.values()) { + // NOt adding descriptions prior to v12 + switch (v.toString()) { + case "v7": + case "v8": + case "v9": + case "v10": + case "v11": + continue; + } EdgeRules rules = EdgeRules.getInstance(v); rules.getAllRules(); } @@ -277,23 +289,23 @@ public class EdgeRulesTest extends AAISetup { @Test public void verifyOutDirectionUsingLabel() throws AAIException, NoEdgeRuleFoundException { EdgeRules rules = EdgeRules.getInstance(); - EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "generic-vnf", "l3-network", "usesL3Network"); + EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "generic-vnf", "l3-network", "org.onap.relationships.inventory.Uses"); assertEquals("out direction", rule.getDirection(), Direction.OUT); } @Test - public void verifyOutDirectionLinterfaceToLinterfaceUsingLabel() throws AAIException, NoEdgeRuleFoundException { + public void verifyInDirectionLinterfaceToLinterfaceUsingLabel() throws AAIException, NoEdgeRuleFoundException { EdgeRules rules = EdgeRules.getInstance(); EdgeRule rule = rules.getEdgeRule(EdgeType.TREE, "l-interface", "l-interface"); - assertEquals("out direction", rule.getDirection(), Direction.OUT); + assertEquals("in direction", rule.getDirection(), Direction.IN); } @Test public void verifyOutFlippedDirectionUsingLabel() throws AAIException, NoEdgeRuleFoundException { EdgeRules rules = EdgeRules.getInstance(); - EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "l3-network", "generic-vnf", "usesL3Network"); + EdgeRule rule = rules.getEdgeRule(EdgeType.COUSIN, "l3-network", "generic-vnf", "org.onap.relationships.inventory.Uses"); assertEquals("in direction", rule.getDirection(), Direction.IN); } @@ -348,4 +360,28 @@ public class EdgeRulesTest extends AAISetup { Map edgeRules = rules.getEdgeRulesWithLabels(EdgeType.COUSIN, "generic-vnf", "vnfc", labels); } + @Test + public void addEdgeVerifyAAIUUIDCousinTest() throws AAIException { + Graph graph = TinkerGraph.open(); + Vertex v1 = graph.addVertex(T.id, "1", "aai-node-type", "flavor"); + Vertex v2 = graph.addVertex(T.id, "10", "aai-node-type", "vserver"); + EdgeRules rules = EdgeRules.getInstance(Version.getLatest()); + GraphTraversalSource g = graph.traversal(); + Edge e = rules.addEdge(g, v1, v2); + assertTrue(e.property(AAIProperties.AAI_UUID).isPresent()); + //assertTrue(e.property(AAIProperties.AAI_UUID).value().toString().matches("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")); + } + + @Test + public void addEdgeVerifyAAIUUIDTreeTest() throws AAIException { + Graph graph = TinkerGraph.open(); + Vertex v1 = graph.addVertex(T.id, "1", "aai-node-type", "tenant"); + Vertex v2 = graph.addVertex(T.id, "10", "aai-node-type", "vserver"); + EdgeRules rules = EdgeRules.getInstance(Version.getLatest()); + GraphTraversalSource g = graph.traversal(); + Edge e = rules.addTreeEdge(g, v1, v2); + assertTrue(e.property(AAIProperties.AAI_UUID).isPresent()); + //assertTrue(e.property(AAIProperties.AAI_UUID).value().toString().matches("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")); + } + } diff --git a/aai-core/src/test/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngineTest.java b/aai-core/src/test/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngineTest.java index 4b4a0e64..55002a6f 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngineTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngineTest.java @@ -19,7 +19,6 @@ * * ECOMP is a trademark and service mark of AT&T Intellectual Property. */ - package org.onap.aai.serialization.engines.query; import static org.junit.Assert.*; @@ -31,6 +30,8 @@ import java.util.Iterator; import java.util.List; import java.util.Set; +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree; import org.apache.tinkerpop.gremlin.structure.Direction; @@ -51,7 +52,7 @@ import org.onap.aai.introspection.Version; import org.onap.aai.serialization.db.EdgeRules; public class GraphTraversalQueryEngineTest extends AAISetup { - + @Test public void testFindParents() throws AAIException { //setup @@ -236,13 +237,13 @@ public class GraphTraversalQueryEngineTest extends AAISetup { GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g); //test - List outRes = engine.findRelatedVertices(gv, Direction.OUT, "hasLInterface", "l-interface"); + List outRes = engine.findRelatedVertices(gv, Direction.IN, "org.onap.relationships.inventory.BelongsTo", "l-interface"); assertTrue(outRes.containsAll(outExpected) && outExpected.containsAll(outRes)); - - List inRes = engine.findRelatedVertices(log, Direction.IN, "usesLogicalLink", "l-interface"); + + List inRes = engine.findRelatedVertices(log, Direction.IN, "tosca.relationships.network.LinksTo", "l-interface"); assertTrue(inRes.containsAll(inExpected) && inExpected.containsAll(inRes)); - List bothRes = engine.findRelatedVertices(lint, Direction.BOTH, "usesLogicalLink", "logical-link"); + List bothRes = engine.findRelatedVertices(lint, Direction.BOTH, "tosca.relationships.network.LinksTo", "logical-link"); assertTrue(bothRes.containsAll(bothExpected) && bothExpected.containsAll(bothRes)); } diff --git a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/ConsoleTest.java b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/ConsoleTest.java new file mode 100644 index 00000000..a60eaf90 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/ConsoleTest.java @@ -0,0 +1,83 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.serialization.queryformats; + +import static org.junit.Assert.*; +import org.junit.Test; +import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException; + +import com.google.gson.JsonObject; + +public class ConsoleTest { + + + Console fM1 = new Console(); + + String param = "abcd"; + + JsonObject resultVal; + + @Test + public void classConsoleInstantiateCheck() { + + try { + Console fm1 = new Console(); + assertNotNull("Created class Object is null", fm1); + } + catch(Exception e) { + fail(); + } + } + + //Below method is expecting to throw an exception + + @Test(expected=NullPointerException.class) + public void formatObjectParamNullCheck() throws AAIFormatVertexException { + + param=null; + Console fm3 = new Console(); + resultVal = fm3.formatObject(param); + } + + @Test + public void formatObjectResultCheck() { + + try { + Console fm2 = new Console(); + + resultVal = fm2.formatObject(param); + assertNotNull("The result is null", resultVal); + + //System.out.println(resultVal); + + JsonObject jsonObj = new JsonObject(); + jsonObj.addProperty("result", "abcd"); + + assertEquals(jsonObj, resultVal); + + } + catch (Exception e) { + fail(); + } + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/GraphSONTest.java b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/GraphSONTest.java new file mode 100644 index 00000000..8f418a43 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/GraphSONTest.java @@ -0,0 +1,80 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.serialization.queryformats; + +import org.apache.tinkerpop.gremlin.structure.Graph; +import org.apache.tinkerpop.gremlin.structure.Vertex; +import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph; +import org.junit.*; +import static org.junit.Assert.assertEquals; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; + +public class GraphSONTest { + + private Graph graph; + private Vertex v1; + + //private JsonObject jsonObj = new JsonParser().parse("{\"id\":0,\"label\":\"vertex\",\"properties\":{\"name\":[{\"id\":1,\"value\":\"Sam\"}]}}").getAsJsonObject(); + private JsonObject jsonObj = new JsonObject() ; + private JsonObject properties = new JsonObject(); + private JsonArray name = new JsonArray() ; + private JsonObject idVal = new JsonObject() ; + + @Before + public void setUp() { + + jsonObj.addProperty("id", 0); + jsonObj.addProperty("label", "vertex"); + + idVal.addProperty("id", 1); + idVal.addProperty("value", "Sam"); + + name.add(idVal); + properties.add("name",name); + jsonObj.add("properties", properties); + + graph = TinkerGraph.open(); + v1 = graph.addVertex("name", "Sam"); + + } + + @Test + public void classGraphSONTestWithVertex(){ + + GraphSON graphSonObj1 = new GraphSON(); + JsonObject obj = graphSonObj1.formatObject(v1); + + assertEquals(jsonObj, obj); + } + + @Test + public void parallelThresholdCehck(){ + + GraphSON graphSonObj2 = new GraphSON(); + assertEquals(50, graphSonObj2.parallelThreshold()); + + } + + +} diff --git a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/RawFormatTest.java b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/RawFormatTest.java index a33349fd..ae76467c 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/RawFormatTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/RawFormatTest.java @@ -92,7 +92,7 @@ public class RawFormatTest extends AAISetup { @Test public void verifyPserverRelatedToHasEdgeLabel () throws AAIFormatVertexException, AAIException, AAIFormatQueryResultFormatNotSupported { - assertTrue(rawFormat.createRelationshipObject(pserver).get(0).getAsJsonObject().get("relationship-label").getAsString().equals("locatedIn")); + assertTrue(rawFormat.createRelationshipObject(pserver).get(0).getAsJsonObject().get("relationship-label").getAsString().equals("org.onap.relationships.inventory.LocatedIn")); } @Test @@ -102,7 +102,7 @@ public class RawFormatTest extends AAISetup { @Test public void verifyComplexRelatedToHasEdgeLabel () throws AAIFormatVertexException, AAIException, AAIFormatQueryResultFormatNotSupported { - assertTrue(rawFormat.createRelationshipObject(complex).get(0).getAsJsonObject().get("relationship-label").getAsString().equals("locatedIn")); + assertTrue(rawFormat.createRelationshipObject(complex).get(0).getAsJsonObject().get("relationship-label").getAsString().equals("org.onap.relationships.inventory.LocatedIn")); } @Test diff --git a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/SimpleFormatTest.java b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/SimpleFormatTest.java index ec89aa30..fd3a8893 100644 --- a/aai-core/src/test/java/org/onap/aai/serialization/queryformats/SimpleFormatTest.java +++ b/aai-core/src/test/java/org/onap/aai/serialization/queryformats/SimpleFormatTest.java @@ -19,7 +19,6 @@ * * ECOMP is a trademark and service mark of AT&T Intellectual Property. */ - package org.onap.aai.serialization.queryformats; import com.google.gson.JsonObject; diff --git a/aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java b/aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java new file mode 100644 index 00000000..b149e95f --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java @@ -0,0 +1,77 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; + +import org.junit.Assert; +import org.junit.Test; + +public class AAICSVWriterTest { + + private final String TEMP_DIR=System.getProperty("java.io.tmpdir")+"/test.csv"; + + @Test + public void writeFile() throws IOException + { + + + FileWriter fileWriter = new FileWriter(TEMP_DIR); + AAICSVWriter aaicsvWriter = new AAICSVWriter(fileWriter, ",", '\'', null); + aaicsvWriter.writeColumn(new String[]{"id", "name", null}); + aaicsvWriter.writeColumn(null); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}, true); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test@"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}); + aaicsvWriter.writeNext(new String[]{"1", null}); + aaicsvWriter.writeNext(null); + aaicsvWriter.close(); + File file = new File(TEMP_DIR); + Assert.assertTrue("File shoud be exists", file.exists()); + } + + @Test + public void writeFile1() throws IOException + { + FileWriter fileWriter = new FileWriter(TEMP_DIR); + AAICSVWriter aaicsvWriter = new AAICSVWriter(fileWriter, ",", '\u0000', null); + aaicsvWriter.writeNext(new String[]{"1", "Test1"}, true); + aaicsvWriter.writeNext(new String[]{"1", "Tes\"t@"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Tes\t@"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Test,@"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Tes\n"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Tes\r"}, false); + aaicsvWriter.writeNext(new String[]{"1", "Tes\u0000"}, false); + aaicsvWriter.close(); + File file = new File(TEMP_DIR); + Assert.assertTrue("File shoud be exists", file.exists()); + + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/AAIConfigCommandLinePropGetterTest.java b/aai-core/src/test/java/org/onap/aai/util/AAIConfigCommandLinePropGetterTest.java new file mode 100644 index 00000000..fcce479a --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/AAIConfigCommandLinePropGetterTest.java @@ -0,0 +1,105 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertEquals; + +import java.security.Permission; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.AAISetup; + +public class AAIConfigCommandLinePropGetterTest extends AAISetup { + + private SecurityManager m; + private TestSecurityManager sm; + + @Before + public void setUp() + { + m = System.getSecurityManager(); + sm = new TestSecurityManager(); + System.setSecurityManager(sm); + } + + @After + public void tearDown() + { + System.setSecurityManager(m); + } + + @Test + public void testMainNoArgs() { + try { + AAIConfigCommandLinePropGetter.main(new String[] {}); + } catch (SecurityException se) { + // assert main method ends with System.exit(0) + assertEquals("0", se.getMessage()); + } + } + + @Test + public void testMainReadProp() { + try { + AAIConfigCommandLinePropGetter.main(new String[] {"aai.primary.filetransfer.serverlist"}); + } catch (SecurityException se) { + // assert main method ends with System.exit(0) + assertEquals("0", se.getMessage()); + } + } + + @Test + public void testMainOneArg() { + try { + AAIConfigCommandLinePropGetter.main(new String[] {"one"}); + } catch (SecurityException se) { + // assert main method ends with System.exit(0) + assertEquals("0", se.getMessage()); + } + } + + @Test + public void testMainMoreThanOneArg() { + try { + AAIConfigCommandLinePropGetter.main(new String[] {"one", "two"}); + } catch (SecurityException se) { + // assert main method ends with System.exit(0) + assertEquals("0", se.getMessage()); + } + } +} + +class TestSecurityManager extends SecurityManager { + @Override + public void checkPermission(Permission permission) { + if ("exitVM".equals(permission.getName())) + { + throw new SecurityException("System.exit attempted and blocked."); + } + } + @Override + public void checkExit(int status) { + throw new SecurityException(Integer.toString(status)); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/AAIRSyncUtilityTest.java b/aai-core/src/test/java/org/onap/aai/util/AAIRSyncUtilityTest.java new file mode 100644 index 00000000..f5daf3b0 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/AAIRSyncUtilityTest.java @@ -0,0 +1,55 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; + +import java.util.ArrayList; +import java.util.List; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.Mockito; +import org.onap.aai.AAISetup; + +public class AAIRSyncUtilityTest extends AAISetup { + + private static AAIRSyncUtility syncUtility; + + @BeforeClass + public static void setUp() throws Exception { + syncUtility = new AAIRSyncUtility(); + } + + @Test(expected = NullPointerException.class) + public void testDoCommandNullCommands() throws Exception { + syncUtility.doCommand(null); + } + + @Test(expected = Exception.class) + public void testDoCommandEmptyCommands() throws Exception { + List commands = new ArrayList(); + syncUtility.doCommand(commands); + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/FileWatcherTest.java b/aai-core/src/test/java/org/onap/aai/util/FileWatcherTest.java new file mode 100644 index 00000000..bb754c0e --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/FileWatcherTest.java @@ -0,0 +1,78 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.*; + +import java.io.File; + +import org.junit.Test; +import org.mockito.Mockito; + +public class FileWatcherTest { + + class FileWatcherExtension extends FileWatcher { + + public FileWatcherExtension(File file) { + super(file); + } + + @Override + protected void onChange(File file) { + System.out.println("do nothing"); + } + } + + @Test + public void testFileWatcher() { + File file = new File("helloworld"); + file.setLastModified(new Long(123)); + FileWatcher fileWatcher = new FileWatcherExtension(file); + assertNotNull(fileWatcher); + file.deleteOnExit(); + } + + @Test(expected=NullPointerException.class) + public void testFileWatcher_nullConstructor() { + FileWatcher fileWatcher = new FileWatcherExtension(null); + assertNull(fileWatcher); + } + + @Test + public void testRun() { + // verify that code is reachable outside of conditional check in run() + File file = new File("helloworld"); + file.setLastModified(new Long(100)); + FileWatcher fileWatcher = new FileWatcherExtension(file); + fileWatcher.run(); + file.deleteOnExit(); + } + + @Test + public void testOnChange() throws Exception { + FileWatcher fileWatcher = Mockito.mock(FileWatcher.class, Mockito.CALLS_REAL_METHODS); + + fileWatcher.onChange(Mockito.any(File.class)); + + Mockito.verify(fileWatcher).onChange(Mockito.any(File.class)); + } +} 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 9a36680b..9e1e33a5 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 @@ -21,35 +21,271 @@ */ package org.onap.aai.util; -import org.junit.Test; -import org.onap.aai.introspection.Version; +import static org.junit.Assert.*; -public class GenerateXsdTest { +import java.io.StringReader; + +import javax.xml.XMLConstants; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; - @Test - public void testGenerationOfXsdAndYaml() throws Exception { +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; - GenerateXsd generateXsd = new GenerateXsd(); - System.setProperty("gen_version", Version.getLatest().toString()); - System.setProperty("gen_type", "XSD"); - System.setProperty("yamlresponses_url", ""); - System.setProperty("yamlresponses_label", ""); +import org.onap.aai.introspection.Version; - generateXsd.main(new String[]{}); - System.setProperty("gen_version", Version.getLatest().toString()); - System.setProperty("gen_type", "YAML"); +public class GenerateXsdTest { + private static final int maxSizeForXml = 20000; + 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"); + } + + 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() { + - String wikiLink = System.getProperty("aai.wiki.link"); + GenerateXsd generateXsd = new GenerateXsd(); + + //GenerateXsd generateXsdSpy = PowerMockito.spy(generateXsd); - if(wikiLink == null){ - wikiLink = "https://wiki.onap.org/"; - } + //generateXsdSpy.processOxmFile(null, Version.getLatest(), testXML); - System.setProperty("yamlresponses_url", wikiLink); - System.setProperty("yamlresponses_label", "Response codes found in [response codes]"); + String xsdResult = generateXsd.processOxmFile(null, Version.getLatest(), testXML); + + 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); + } + @Test + public void test_generateSwaggerFromOxmFile( ) { + - generateXsd.main(new String[]{}); - } + GenerateXsd generateXsd = new GenerateXsd(); + 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); + } } diff --git a/aai-core/src/test/java/org/onap/aai/util/HbaseSaltPrefixerTest.java b/aai-core/src/test/java/org/onap/aai/util/HbaseSaltPrefixerTest.java new file mode 100644 index 00000000..918f8974 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/HbaseSaltPrefixerTest.java @@ -0,0 +1,72 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.*; + + +import org.junit.Test; + + +public class HbaseSaltPrefixerTest { + + HbaseSaltPrefixer obj = HbaseSaltPrefixer.getInstance(); + + //Sample key value used for testing + String key = "foo1234"; + + String result = obj.prependSalt(key); + + @Test + public void classInstantiateCheck() { + try { + assertNotNull("Created class Object is not null", obj); + } + catch(Exception e) { + fail(); + } + } + + @Test + public void prependSaltResult_NullCheck () { + try { + assertNotNull("result is not null", result); + } + catch(NullPointerException e) { + fail(); + } + } + + @Test + public void prependSaltResult_PrefixSuccessChecks () { + try { + // Ensure that '-' has been prepended + assertFalse(result.startsWith("-")); + // Ensure that *something* has been prepended + assertFalse(result.equalsIgnoreCase(key)); + } + catch (Exception e) { + fail(); + } + } + +} diff --git a/aai-core/src/test/java/org/onap/aai/util/KeyValueListTest.java b/aai-core/src/test/java/org/onap/aai/util/KeyValueListTest.java new file mode 100644 index 00000000..c05ffefc --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/KeyValueListTest.java @@ -0,0 +1,76 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import org.junit.Before; +import org.junit.Test; +import static org.junit.Assert.*; + +public class KeyValueListTest { + KeyValueList kv; + KeyValueList kv1; + + @Before + public void setup() { + String key = "key"; + String value = "value"; + kv = new KeyValueList(); + kv.setKey(key); + kv.setValue(value); + kv.setAdditionalProperty("name1", "val1"); + kv1 = new KeyValueList(); + kv1.setKey("key1"); + kv1.setValue("value1"); + } + + @Test + public void getSetTest() { + assertEquals("key", kv.getKey()); + assertEquals("value", kv.getValue()); + } + + @Test + public void additionalPropertyTest() { + assertEquals("Additional properties added", "val1", kv.getAdditionalProperties().get("name1")); + } + + @Test + public void hashCodeTest() { + assertEquals("Hashing function returns the same code", kv.hashCode(), kv.hashCode()); + assertNotEquals("Hashing function returns different code for different objects", kv.hashCode(), kv1.hashCode()); + } + + @Test + public void equalsTest() { + KeyValueList kv2 = new KeyValueList(); + kv2.setKey("key"); + kv2.setValue("value"); + kv2.setAdditionalProperty("name1", "val1"); + assertTrue("Equal KeyValueList objects", kv.equals(kv2)); + assertFalse("Non-equal KeyValueList objects", kv.equals(kv1)); + } + + @Test + public void toStringTest() { + assertNotEquals("Different objects should return different strings", kv.toString(), kv1.toString()); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/MapperUtilTest.java b/aai-core/src/test/java/org/onap/aai/util/MapperUtilTest.java new file mode 100644 index 00000000..dae2c22d --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/MapperUtilTest.java @@ -0,0 +1,72 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import org.json.JSONObject; +import org.junit.Before; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; + +public class MapperUtilTest { + + public class SampleClass { + private String color; + private String shape; + + public SampleClass(String c, String s){ + color = c; + shape = s; + } + + public String getColor() { + return color; + } + + public void setColor(String color) { + this.color = color; + } + + public String getShape() { + return shape; + } + + public void setShape(String shape) { + this.shape = shape; + } + } + + private JSONObject expectedJson; + + @Before + public void setup(){ + expectedJson = new JSONObject(); + } + + @Test + public void writeAsJSONStringTest() throws Exception { + expectedJson.put("color", "black"); + expectedJson.put("shape", "box"); + SampleClass sample = new SampleClass("black", "box"); + assertEquals(expectedJson.toString(), MapperUtil.writeAsJSONString(sample)); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/PojoUtilsTest.java b/aai-core/src/test/java/org/onap/aai/util/PojoUtilsTest.java new file mode 100644 index 00000000..7121a82b --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/PojoUtilsTest.java @@ -0,0 +1,107 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import java.time.LocalDateTime; +import java.time.Month; + +import org.junit.Test; +import org.mockito.Mockito; + +public class PojoUtilsTest { + + @Test + public void testGetJsonFromObject_Clazz_MockTest() throws Exception { + + String obj = "helloWorld"; + PojoUtils pojoUtils = Mockito.mock(PojoUtils.class); + Mockito.doCallRealMethod().when(pojoUtils).getJsonFromObject(Mockito.anyString()); + + pojoUtils.getJsonFromObject(obj); + + Mockito.verify(pojoUtils, Mockito.times(1)).getJsonFromObject(Mockito.anyString(), Mockito.eq(false), Mockito.eq(true)); + } + + @Test + public void testGetJsonFromObject_Clazz() throws Exception { + + PojoUtils pojoUtils = PojoUtilsTest.getInstance(); + LocalDateTime date = LocalDateTime.of(2017, Month.SEPTEMBER, 18, 10, 55, 0, 300); + + String res = pojoUtils.getJsonFromObject(date); + + assertNotNull(res); + assertTrue(res.contains("\"dayOfMonth\" : 18")); + assertTrue(res.contains("\"dayOfWeek\" : \"MONDAY\"")); + assertTrue(res.contains("\"dayOfYear\" : 261")); + assertTrue(res.contains("\"hour\" : 10")); + assertTrue(res.contains("\"minute\" : 55")); + assertTrue(res.contains("\"month\" : \"SEPTEMBER\"")); + assertTrue(res.contains("\"monthValue\" : 9")); + assertTrue(res.contains("\"nano\" : 300")); + assertTrue(res.contains("\"second\" : 0")); + assertTrue(res.contains("\"year\" : 2017")); + } + + @Test + public void testGetJsonFromObject_Clazz_null() throws Exception { + PojoUtils pojoUtils = PojoUtilsTest.getInstance(); + + String res = pojoUtils.getJsonFromObject(null); + + assertNotNull(res); + assertEquals("null", res); + } + + @Test + public void testGetJsonFromObject_null() throws Exception { + PojoUtils pojoUtils = PojoUtilsTest.getInstance(); + + String res = pojoUtils.getJsonFromObject(null, false, true); + + assertNotNull(res); + assertEquals("null", res); + } + + @Test + public void testGetJsonFromObject() throws Exception { + PojoUtils pojoUtils = PojoUtilsTest.getInstance(); + LocalDateTime date = LocalDateTime.of(2017, Month.SEPTEMBER, 18, 10, 55, 0, 300); + + String res = pojoUtils.getJsonFromObject(date, false, false); + assertNotNull(res); + + res = pojoUtils.getJsonFromObject(date, true, false); + assertNotNull(res); + + res = pojoUtils.getJsonFromObject(date, true, true); + assertNotNull(res); + } + + static PojoUtils getInstance() { + return new PojoUtils(); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/util/RestURLEncoderTest.java b/aai-core/src/test/java/org/onap/aai/util/RestURLEncoderTest.java new file mode 100644 index 00000000..e296b5e1 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/RestURLEncoderTest.java @@ -0,0 +1,63 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.fail; + +import org.junit.Test; + +public class RestURLEncoderTest { + + @Test + public void testEncodeURL() throws Exception { + + String url = "nodeKeyTest&more-string strings"; + String encodedUrl = "nodeKeyTest%26more-string%20strings"; + + String res = RestURLEncoder.encodeURL(url); + assertEquals(encodedUrl, res); + } + + @Test + public void testEncodeURL_plusSign() throws Exception { + + String url = "nodeKeyTest+more+string"; + String encodedUrl = "nodeKeyTest%2Bmore%2Bstring"; + + String res = RestURLEncoder.encodeURL(url); + assertEquals(encodedUrl, res); + } + + @Test + public void testEncodeURL_noException() throws Exception { + // no exception expected, none thrown: passes. + try { + String encodeResult = RestURLEncoder.encodeURL(""); + + assertNotNull("Result is not null", encodeResult); + } catch (Exception e) { + fail(); + } + } +} 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 new file mode 100644 index 00000000..5c87b29e --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java @@ -0,0 +1,235 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright Ā© 2017 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========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.util; + +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import java.io.IOException; +import java.io.InputStream; +import java.io.StringWriter; +import java.util.HashMap; +import java.util.Map; + +import javax.json.Json; +import javax.json.JsonObject; + +import org.eclipse.persistence.dynamic.DynamicEntity; +import org.eclipse.persistence.dynamic.DynamicType; +import org.eclipse.persistence.jaxb.JAXBContextProperties; +import org.eclipse.persistence.jaxb.JAXBMarshaller; +import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext; +import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContextFactory; +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.Mockito; +import org.onap.aai.AAISetup; +import org.onap.aai.dmaap.AAIDmaapEventJMSProducer; +import org.onap.aai.domain.notificationEvent.NotificationEvent.EventHeader; +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 com.fasterxml.jackson.core.JsonGenerationException; +import com.fasterxml.jackson.databind.JsonMappingException; + +public class StoreNotificationEventTest extends AAISetup { + + private static AAIDmaapEventJMSProducer producer; + private static StoreNotificationEvent sne; + + @BeforeClass + public static void setUp() throws Exception { + producer = Mockito.mock(AAIDmaapEventJMSProducer.class); + sne = new StoreNotificationEvent(producer, "transiationId", "sourceOfTruth"); + } + + @Test(expected = AAIException.class) + public void testStoreEventNullObj() throws AAIException { + sne.storeEvent(new EventHeader(), null); + } + + @Test(expected = AAIException.class) + public void testStoreEventInvalidObjForPojoUtils() throws AAIException { + sne.storeEvent(new EventHeader(), new Object()); + } + + @Test + public void testStoreEventEmptyEventHeader() throws AAIException, JsonGenerationException, JsonMappingException, IOException { + JsonObject object = Json.createObjectBuilder().add("hello", "world").build(); + String res = sne.storeEvent(new EventHeader(), object); + + assertNotNull(res); + assertTrue(res.contains("\"cambria.partition\" : \"" + AAIConstants.UEB_PUB_PARTITION_AAI + "\"")); + assertTrue(res.contains("\"event-header\"")); + assertTrue(res.contains("\"id\"")); + assertTrue(res.contains("\"timestamp\"")); + assertTrue(res.contains("\"source-name\" : \"" + AAIConfig.get("aai.notificationEvent.default.sourceName") + "\"")); + assertTrue(res.contains("\"domain\" : \"" + AAIConfig.get("aai.notificationEvent.default.domain") + "\"")); + assertTrue(res.contains("\"sequence-number\" : \"" + AAIConfig.get("aai.notificationEvent.default.sequenceNumber") + "\"")); + assertTrue(res.contains("\"severity\" : \"" + AAIConfig.get("aai.notificationEvent.default.severity") + "\"")); + assertTrue(res.contains("\"event-type\" : \"" + AAIConfig.get("aai.notificationEvent.default.eventType") + "\"")); + assertTrue(res.contains("\"version\" : \"" + AAIConfig.get("aai.notificationEvent.default.version") + "\"")); + assertTrue(res.contains("\"action\" : \"UNK\"")); + assertTrue(res.contains("\"entity-link\" : \"UNK\"")); + assertTrue(res.contains("\"entity\"")); + assertTrue(res.contains("\"hello\"")); + assertTrue(res.contains("\"chars\" : \"world\"")); + assertTrue(res.contains("\"string\" : \"world\"")); + assertTrue(res.contains("\"valueType\" : \"STRING\"")); + } + + @Test + public void testStoreEvent() throws AAIException, JsonGenerationException, JsonMappingException, IOException { + JsonObject object = Json.createObjectBuilder().add("hello", "world").build(); + EventHeader eh = new EventHeader(); + eh.setId("123"); + eh.setTimestamp("current-time"); + eh.setEntityLink("entity-link"); + eh.setAction("action!"); + eh.setEventType("surprise"); + eh.setDomain("PROD"); + eh.setSourceName("source"); + eh.setSequenceNumber("23"); + eh.setSeverity("ALERT"); + eh.setVersion("v11"); + + String res = sne.storeEvent(eh, object); + + assertNotNull(res); + assertTrue(res.contains("\"cambria.partition\" : \"" + AAIConstants.UEB_PUB_PARTITION_AAI + "\"")); + assertTrue(res.contains("\"event-header\"")); + assertTrue(res.contains("\"id\" : \"123\"")); + assertTrue(res.contains("\"timestamp\" : \"current-time\"")); + assertTrue(res.contains("\"source-name\" : \"source\"")); + assertTrue(res.contains("\"domain\" : \"PROD\"")); + 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("\"action\" : \"action!\"")); + assertTrue(res.contains("\"entity-link\" : \"entity-link\"")); + assertTrue(res.contains("\"entity\"")); + assertTrue(res.contains("\"hello\"")); + assertTrue(res.contains("\"chars\" : \"world\"")); + assertTrue(res.contains("\"string\" : \"world\"")); + assertTrue(res.contains("\"valueType\" : \"STRING\"")); + } + + @Test(expected=AAIException.class) + public void testStoreDynamicEventNullObj() throws AAIException { + DynamicEntity eventHeader = Mockito.mock(DynamicEntity.class); + DynamicJAXBContext notificationJaxbContext = Mockito.mock(DynamicJAXBContext.class); + sne.storeDynamicEvent(notificationJaxbContext, "v11", eventHeader, null); + } + + @Test(expected = AAIException.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("bundleconfig-local/etc/oxm/aai_oxm_v11.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 dt = Mockito.mock(DynamicType.class); + DynamicEntity notificationEventReal = dtReal.newDynamicEntity(); + JAXBMarshaller marshaller = Mockito.mock(JAXBMarshaller.class); + + Mockito.when(notificationJaxbContext.getDynamicType(Mockito.anyString())).thenReturn(dt); + Mockito.when(dt.newDynamicEntity()).thenReturn(notificationEventReal); + 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); + } + + @Test(expected = AAIException.class) + public void testStoreEventIntrospectorNullObj() throws Exception { + Loader loader = Mockito.mock(Loader.class); + sne.storeEvent(loader, null, null); + } + + @Test + public void testStoreEventIntrospector() throws Exception { + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); + Introspector eventHeader = loader.introspectorFromName("notification-event-header"); + eventHeader.setValue("id", "123"); + eventHeader.setValue("timestamp", "current-time"); + eventHeader.setValue("entity-link", "entity-link"); + eventHeader.setValue("action", "action!"); + eventHeader.setValue("event-type", "surprise"); + eventHeader.setValue("domain", "PROD"); + eventHeader.setValue("source-name", "source"); + eventHeader.setValue("sequence-number", "23"); + eventHeader.setValue("severity", "ALERT"); + eventHeader.setValue("version", "v11"); + + Introspector obj = loader.introspectorFromName("notification-event"); + + String res = sne.storeEvent(loader, eventHeader, obj); + + assertNotNull(res); + assertTrue(res.contains("\"cambria.partition\":\"" + AAIConstants.UEB_PUB_PARTITION_AAI + "\"")); + assertTrue(res.contains("\"event-header\"")); + assertTrue(res.contains("\"id\":\"123\"")); + assertTrue(res.contains("\"timestamp\":\"current-time\"")); + assertTrue(res.contains("\"source-name\":\"source\"")); + assertTrue(res.contains("\"domain\":\"PROD\"")); + 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("\"action\":\"action!\"")); + assertTrue(res.contains("\"entity-link\":\"entity-link\"")); + assertTrue(res.contains("\"notification-event\"")); + } + + @Test + public void testStoreEventIntrospectorEmptyEventHeader() throws Exception { + Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v11); + Introspector eventHeader = loader.introspectorFromName("notification-event-header"); + Introspector obj = loader.introspectorFromName("notification-event"); + + String res = sne.storeEvent(loader, eventHeader, obj); + + assertNotNull(res); + assertTrue(res.contains("\"cambria.partition\":\"" + AAIConstants.UEB_PUB_PARTITION_AAI + "\"")); + assertTrue(res.contains("\"event-header\"")); + assertTrue(res.contains("\"id\"")); + assertTrue(res.contains("\"timestamp\"")); + assertTrue(res.contains("\"source-name\":\"" + AAIConfig.get("aai.notificationEvent.default.sourceName") + "\"")); + assertTrue(res.contains("\"domain\":\"" + AAIConfig.get("aai.notificationEvent.default.domain") + "\"")); + assertTrue(res.contains("\"sequence-number\":\"" + AAIConfig.get("aai.notificationEvent.default.sequenceNumber") + "\"")); + assertTrue(res.contains("\"severity\":\"" + AAIConfig.get("aai.notificationEvent.default.severity") + "\"")); + assertTrue(res.contains("\"event-type\":\"" + AAIConfig.get("aai.notificationEvent.default.eventType") + "\"")); + assertTrue(res.contains("\"version\":\"" + AAIConfig.get("aai.notificationEvent.default.version") + "\"")); + assertTrue(res.contains("\"action\":\"UNK\"")); + assertTrue(res.contains("\"entity-link\":\"UNK\"")); + assertTrue(res.contains("\"notification-event\"")); + } +} diff --git a/aai-core/src/test/java/org/onap/aai/workarounds/LegacyURITransformerTest.java b/aai-core/src/test/java/org/onap/aai/workarounds/LegacyURITransformerTest.java new file mode 100644 index 00000000..ebcaf750 --- /dev/null +++ b/aai-core/src/test/java/org/onap/aai/workarounds/LegacyURITransformerTest.java @@ -0,0 +1,104 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright (C) 2017 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.workarounds; + +import org.junit.Test; +import org.onap.aai.AAISetup; +import org.onap.aai.introspection.Version; + +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; + +import static org.junit.Assert.assertEquals; + + +public class LegacyURITransformerTest extends AAISetup { + + private LegacyURITransformer uriTransformer = LegacyURITransformer.getInstance(); + private String fromSuccess = "http://myhostname.com:8443/aai/{version}/cloud-infrastructure/tenants/tenant/key1/vservers/vserver/key2"; + private String toSuccess = "http://myhostname.com:8443/aai/servers/{version}/key1/vservers/key2"; + + + /** + * V 5. + * @throws URISyntaxException + * + * @throws MalformedURLException the malformed URL exception + */ + @Test + public void v5() throws URISyntaxException { + testSpec(Version.v8, fromSuccess, fromSuccess); + } + + + /** + * Test spec. + * + * @param version the version + * @param toExpected the to expected + * @param fromExpected the from expected + * @throws URISyntaxException + * @throws MalformedURLException the malformed URL exception + */ + public void testSpec(Version version, String toExpected, String fromExpected) throws URISyntaxException { + + URI toExpectedUri = new URI(toExpected.replace("{version}",version.toString())); + URI fromExpectedUri = new URI(fromExpected.replace("{version}",version.toString())); + + URI result = toLegacyURISpec(version, fromExpectedUri); + + assertEquals("to", toExpectedUri, result); + + result = fromLegacyURISpec(version, toExpectedUri); + + assertEquals("from", fromExpectedUri, result); + } + + + /** + * To legacy URL spec. + * + * @param version the version + * @param url the url + * @return the url + * @throws URISyntaxException + * @throws MalformedURLException the malformed URL exception + */ + public URI toLegacyURISpec(Version version, URI uri) throws URISyntaxException { + return uri; + } + + /** + * From legacy URL spec. + * + * @param version the version + * @param url the url + * @return the url + * @throws URISyntaxException + * @throws MalformedURLException the malformed URL exception + */ + public URI fromLegacyURISpec(Version version, URI uri) throws URISyntaxException { + return uri; + } + + +} diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/appprops/aaiconfig.properties b/aai-core/src/test/resources/bundleconfig-local/etc/appprops/aaiconfig.properties index c91976f3..d484a415 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/appprops/aaiconfig.properties +++ b/aai-core/src/test/resources/bundleconfig-local/etc/appprops/aaiconfig.properties @@ -20,10 +20,74 @@ # ECOMP is a trademark and service mark of AT&T Intellectual Property. # -aai.server.url.base=https://baseurl:8443/aai/ +#################################################################### +# REMEMBER TO THINK ABOUT ENVIRONMENTAL DIFFERENCES AND CHANGE THE +# TEMPLATE AND *ALL* DATAFILES +#################################################################### + +aai.config.checktime=1000 + +# this could come from siteconfig.pl? +aai.config.nodename=AutomaticallyOverwritten + +aai.logging.hbase.interceptor=true +aai.logging.hbase.enabled=true +aai.logging.hbase.logrequest=true +aai.logging.hbase.logresponse=true + +aai.logging.trace.enabled=true +aai.logging.trace.logrequest=false +aai.logging.trace.logresponse=false + +aai.transaction.logging=true +aai.transaction.logging.get=true +aai.transaction.logging.post=true + +aai.server.url.base=https://localhost:8443/aai/ +aai.server.url=https://localhost:8443/aai/v12/ +aai.global.callback.url=https://localhost:8443/aai/ + +aai.default.api.version=v12 aai.resourceversion.enableflag=true -aai.logging.maxStackTraceEntries=10 -aai.default.api.version=v9 + +aai.notification.current.version=v12 +aai.notificationEvent.default.status=UNPROCESSED +aai.notificationEvent.default.eventType=AAI-EVENT +aai.notificationEvent.default.domain=devINT1 +aai.notificationEvent.default.sourceName=aai +aai.notificationEvent.default.sequenceNumber=0 +aai.notificationEvent.default.severity=NORMAL +aai.notificationEvent.default.version=v12 + + +# Used by Model-processing code +aai.model.delete.sleep.per.vtx.msec=500 +aai.model.query.resultset.maxcount=50 +aai.model.query.timeout.sec=90 + +# Used by Data Grooming +aai.grooming.default.max.fix=150 +aai.grooming.default.sleep.minutes=7 + +# Used by DupeTool +aai.dupeTool.default.max.fix=25 +aai.dupeTool.default.sleep.minutes=7 + +aai.model.proc.max.levels=50 +aai.edgeTag.proc.max.levels=50 + +# Used by the ForceDelete tool +aai.forceDel.protected.nt.list=cloud-region +aai.forceDel.protected.edge.count=10 +aai.forceDel.protected.descendant.count=10 + +# Used for CTAG-Pool generation +aai.ctagPool.rangeString.vplsPe1=2001-2500 +aai.ctagPool.rangeString.vplsPe2=2501-3000 + +aai.dmaap.workload.enableEventProcessing=true + +aai.realtime.clients=JUNIT aai.server.rebind=g aai.run.migrations=false diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/appprops/error.properties b/aai-core/src/test/resources/bundleconfig-local/etc/appprops/error.properties index 11416ca4..da9f5e5b 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/appprops/error.properties +++ b/aai-core/src/test/resources/bundleconfig-local/etc/appprops/error.properties @@ -49,18 +49,13 @@ AAI_4008=5:4:ERROR:4008:500:3002:Output parsing error AAI_4009=4:0:ERROR:4009:400:3000:Invalid X-FromAppId in header AAI_4010=4:0:ERROR:4010:400:3000:Invalid X-TransactionId in header AAI_4011=5:4:ERROR:4011:500:3002:Missing data for REST error response -AAI_4012=5:4:ERROR:4012:500:3002:Bad rule data in RestRules -AAI_4013=5:4:ERROR:4013:500:3002:Error connecting to AAI REST API AAI_4014=4:0:ERROR:4014:400:3000:Invalid Accept header AAI_4015=4:0:ERROR:4015:400:3000:You must provide at least one indexed property AAI_4016=4:0:ERROR:4016:400:3000:The depth parameter must be a number or the string "all" AAI_4017=5:2:INFO:4017:400:3000:Could not set property AAI_4018=5:2:ERROR:4018:400:3000:Unable to convert the string to integer -#--- aaidbmap: 5101-5199 -AAI_5101=5:4:FATAL:5101:500:3002:Could not connect to database +#--- aaidbmap: 5102-5199 AAI_5102=5:4:FATAL:5102:500:3002:Graph database is null after open -AAI_5103=5:4:ERROR:5103:500:3002:Unexpected error during commit -AAI_5104=5:4:ERROR:5104:500:3002:Unexpected error during rollback AAI_5105=5:4:ERROR:5105:500:3002:Unexpected error reading/updating database AAI_5106=5:4:WARN:5106:404:3001:Node not found AAI_5107=5:2:WARN:5107:400:3000:Required information missing @@ -148,6 +143,7 @@ AAI_7401=5:4:ERROR:7401:500:3002:Error connecting to AAI REST API AAI_7402=5:4:ERROR:7402:500:3002:Unexpected error AAI_7403=5:4:WARN:7403:400:3001:Request error AAI_7404=5:4:INFO:7404:404:3001:Node not found +AAI_7405=5:4:WARN:7405:200:0:UUID not formatted correctly, generating UUID #--- aaiauth: 9101-9199 AAI_9101=5:0:WARN:9101:403:3300:User is not authorized to perform function diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml index d3c46600..51eaa349 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml +++ b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml @@ -23,5819 +23,5416 @@ --> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml index ecbfefb8..90d023ce 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml +++ b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml @@ -24,7 +24,7 @@ --> - + @@ -33,7 +33,7 @@ - + @@ -229,6 +229,270 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -258,7 +522,7 @@ - + @@ -296,6 +560,22 @@ + + + + + + + + + + + + + + + + @@ -311,9 +591,12 @@ + + + - + @@ -582,6 +865,11 @@ + + + + + @@ -593,7 +881,7 @@ - + @@ -743,7 +1031,23 @@ - + + + + + + + + + + + + + + + + + @@ -899,7 +1203,7 @@ - + @@ -953,7 +1257,7 @@ - + @@ -968,6 +1272,17 @@ + + + + + + + + + + + @@ -975,8 +1290,7 @@ - - + @@ -1030,7 +1344,7 @@ - + @@ -1275,6 +1589,7 @@ + @@ -1602,6 +1917,16 @@ + + + + + + + + + + @@ -1669,6 +1994,11 @@ + + + + + @@ -1680,7 +2010,13 @@ + + + + + + @@ -1839,7 +2175,7 @@ - + @@ -1898,34 +2234,39 @@ - - + + + + + - + + + + + + - - + + + + + - + - - + + - - - - - - - - - - - + + + + + @@ -1934,24 +2275,12 @@ - - - - - - - - - - - - + + + + + - - - - - @@ -1981,6 +2310,7 @@ + @@ -1988,6 +2318,7 @@ + @@ -2070,6 +2401,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2134,10 +2573,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2145,6 +2621,7 @@ + @@ -2195,11 +2672,6 @@ - - - - - @@ -2226,7 +2698,7 @@ - + @@ -2262,7 +2734,7 @@ - + @@ -2296,8 +2768,8 @@ - - + + @@ -2413,9 +2885,99 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2436,6 +2998,12 @@ + + + + + + @@ -2453,7 +3021,7 @@ - + @@ -2470,6 +3038,7 @@ + @@ -2477,6 +3046,7 @@ + @@ -2612,7 +3182,6 @@ - @@ -2739,11 +3308,6 @@ - - - - - @@ -2754,14 +3318,19 @@ - + - + - + - + + + + + + @@ -2770,7 +3339,6 @@ - @@ -2780,48 +3348,14 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -2964,7 +3498,7 @@ - + @@ -3167,14 +3701,14 @@ - + - + - + - + @@ -3209,15 +3743,31 @@ + + + + + + + + + + + + + + + + - + @@ -3309,6 +3859,7 @@ + @@ -3316,6 +3867,7 @@ + @@ -3518,14 +4070,24 @@ - + + + + + + + + + + + - + - + - + @@ -3533,6 +4095,12 @@ + + + + + + @@ -3565,6 +4133,11 @@ + + + + + @@ -3593,9 +4166,10 @@ + - + @@ -3613,6 +4187,22 @@ + + + + + + + + + + + + + + + + @@ -3680,6 +4270,21 @@ + + + + + + + + + + + + + + + @@ -3731,6 +4336,7 @@ + @@ -3738,6 +4344,7 @@ + @@ -3776,6 +4383,7 @@ + @@ -3786,6 +4394,7 @@ + @@ -3797,7 +4406,27 @@ - + + + + + + + + + + + + + + + + + + + + + @@ -3814,6 +4443,8 @@ + + @@ -3865,6 +4496,7 @@ + @@ -3872,6 +4504,7 @@ + @@ -3995,7 +4628,7 @@ - + @@ -4245,7 +4878,27 @@ - + + + + + + + + + + + + + + + + + + + + + @@ -4355,7 +5008,7 @@ - + @@ -4385,7 +5038,7 @@ - + @@ -4497,11 +5150,10 @@ - - - - - + + + + @@ -5041,7 +5693,7 @@ - + @@ -5049,7 +5701,7 @@ - + @@ -5107,6 +5759,23 @@ + + + + + + + + + + + + + + + + + @@ -5139,6 +5808,7 @@ + @@ -5211,6 +5881,7 @@ + @@ -5218,6 +5889,7 @@ + @@ -5473,368 +6145,218 @@ - + - + - + - + - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + - - + - + - - + - + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + - + - + - + - + - - - - + - + - - - - + - + - - - + - + - + - + - + - + - + - + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml index 30fe6b6f..2364cf82 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml +++ b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml @@ -225,7 +225,7 @@ - + @@ -501,6 +501,7 @@ + @@ -519,7 +520,7 @@ - + @@ -582,7 +583,7 @@ - + @@ -670,7 +671,7 @@ - + @@ -1950,6 +1951,11 @@ + + + + + @@ -2633,22 +2639,22 @@ - + - + - + - + @@ -2871,395 +2877,31 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + @@ -3271,7 +2913,7 @@ - + @@ -3293,26 +2935,36 @@ - + - + - - + + - + + + + + + + + + + + @@ -3320,14 +2972,15 @@ + + - - + + - @@ -3372,7 +3025,7 @@ - + @@ -5064,6 +4717,11 @@ + + + + + @@ -5494,8 +5152,10 @@ - - + + + + @@ -5505,6 +5165,7 @@ + @@ -5562,7 +5223,7 @@ - + @@ -5582,6 +5243,11 @@ + + + + + @@ -6309,22 +5975,22 @@ - + - + - + - + @@ -6711,5 +6377,292 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v2.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v2.xml deleted file mode 100644 index eba7c4b9..00000000 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v2.xml +++ /dev/null @@ -1,1729 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml index 7474362f..d666b738 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml +++ b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml @@ -24,30 +24,332 @@ --> - + - - + + - + + + + + + + - - + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -56,13 +358,13 @@ - - - - - + + + + + @@ -119,5 +421,4235 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml index bfd67319..ecffb2fc 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml +++ b/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml @@ -23,5580 +23,5308 @@ --> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - + - + - + - + + - + - + - - - - - - - - - - - - - - - - - - - - - - - + - + - - - + - + - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - + - - - - + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - + + + + + + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/ambiguous-relationship.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/ambiguous-relationship.json index 241cc146..c6407e2c 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/ambiguous-relationship.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/ambiguous-relationship.json @@ -1,10 +1,10 @@ { - "related-to": "test-object", + "related-to": "generic-vnf", "relationship-data" : [{ - "relationship-key" : "test-object.vnf-id", + "relationship-key" : "generic-vnf.vnf-id", "relationship-value":"key1" },{ - "relationship-key" : "test-object.vnf-id", + "relationship-key" : "generic-vnf.vnf-id", "relationship-value":"key2" }] } \ No newline at end of file diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-failv10-successv9.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-failv10-successv9.json index 0f0378d9..5bafc9ff 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-failv10-successv9.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-failv10-successv9.json @@ -1,8 +1,8 @@ { - "related-to": "test-object", - "related-link": "/aai/v10/network/test-objects/test-objet/key1", + "related-to": "generic-vnf", + "related-link": "/aai/v10/network/generic-vnfs/test-objet/key1", "relationship-data" : [{ - "relationship-key" : "test-object.vnf-id", + "relationship-key" : "generic-vnf.vnf-id", "relationship-value":"key2" }] } \ No newline at end of file diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-successv10-failv9.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-successv10-failv9.json index 490bbd30..3afe6bb7 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-successv10-failv9.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/both-successv10-failv9.json @@ -1,6 +1,6 @@ { - "related-to": "test-object", - "related-link": "http://localhost/aai/v10/network/test-objects/test-object/key1", + "related-to": "generic-vnf", + "related-link": "http://localhost/aai/v10/network/generic-vnfs/generic-vnf/key1", "relationship-data" : [{ "relationship-key" : "test-obect.vnf-id", "relationship-value":"key2" diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/nothing-to-parse.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/nothing-to-parse.json index ea5ff2fe..b24834af 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/nothing-to-parse.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/nothing-to-parse.json @@ -1,4 +1,4 @@ { - "related-to": "test-object", + "related-to": "generic-vnf", "relationship-data" : [] } \ No newline at end of file diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-related-link.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-related-link.json index 15e383aa..4cc103e8 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-related-link.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-related-link.json @@ -1,4 +1,4 @@ { - "related-to": "test-object", - "related-link": "http://localhost/aai/v10/network/test-objects/test-object/key1" + "related-to": "generic-vnf", + "related-link": "http://localhost/aai/v10/network/generic-vnfs/generic-vnf/key1" } \ No newline at end of file diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-relationship-data.json b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-relationship-data.json index dc7445e0..b9fccc9c 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-relationship-data.json +++ b/aai-core/src/test/resources/bundleconfig-local/etc/relationship/only-relationship-data.json @@ -1,7 +1,7 @@ { - "related-to": "test-object", + "related-to": "generic-vnf", "relationship-data" : [{ - "relationship-key" : "test-object.vnf-id", + "relationship-key" : "generic-vnf.vnf-id", "relationship-value":"key1" }] } \ No newline at end of file diff --git a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_TraversalQueryTest.json b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_TraversalQueryTest.json index 0b79192a..515831e9 100644 --- a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_TraversalQueryTest.json +++ b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_TraversalQueryTest.json @@ -10,7 +10,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "vnfc", @@ -21,7 +22,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "vce", @@ -33,7 +35,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "pserver", @@ -45,7 +48,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "generic-vnf", @@ -57,7 +61,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "generic-vnf", @@ -68,7 +73,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "complex", @@ -80,7 +86,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "complex", @@ -91,7 +98,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "l-interface", @@ -103,7 +111,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "l-interface", @@ -115,7 +124,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "false" + "default": "false", + "description": "Hard to describe" }, { "from": "l-interface", @@ -127,7 +137,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "false" + "default": "false", + "description": "Hard to describe" }, { "from": "pserver", @@ -139,7 +150,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" } ] } diff --git a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test.json b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test.json index 76059ed6..9888ed76 100644 --- a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test.json +++ b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test.json @@ -9,7 +9,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "foo", @@ -20,7 +21,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "foo", @@ -31,7 +33,8 @@ "contains-other-v": "${direction}", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "quux", @@ -42,7 +45,8 @@ "contains-other-v": "!${direction}", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "test-parent", @@ -53,7 +57,8 @@ "contains-other-v": "${direction}", "delete-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "test-cousin", @@ -64,7 +69,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "test-child", @@ -75,8 +81,9 @@ "contains-other-v": "${direction}", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" - }, + "prevent-delete": "NONE", + "description": "Hard to describe" + }, { "from": "a", "to": "b", @@ -87,7 +94,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default": "false" + "default": "false", + "description": "Hard to describe" }, { "from": "a", @@ -99,7 +107,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default" : "true" + "default" : "true", + "description": "Hard to describe" }, { "from": "z", @@ -110,7 +119,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "y", @@ -122,7 +132,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "NONE", "prevent-delete": "NONE", - "default" : "true" + "default" : "true", + "description": "Hard to describe" }, { "from": "generic-vnf", @@ -134,7 +145,8 @@ "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", "prevent-delete": "NONE", - "default": "true" + "default": "true", + "description": "Hard to describe" }, { "from": "generic-vnf", @@ -145,7 +157,8 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "generic-vnf", @@ -156,6 +169,30 @@ "contains-other-v": "NONE", "delete-other-v": "${direction}", "SVC-INFRA": "${direction}", + "prevent-delete": "NONE", + "description": "Hard to describe", + "prevent-delete": "NONE" + }, + { + "from": "l-interface", + "to": "logical-link", + "label": "usesLogicalLink", + "direction": "OUT", + "multiplicity": "Many2Many", + "contains-other-v": "NONE", + "delete-other-v": "${direction}", + "SVC-INFRA": "${direction}", + "prevent-delete": "NONE" + }, + { + "from": "generic-vnf", + "to": "l-interface", + "label": "hasLInterface", + "direction": "OUT", + "multiplicity": "Many2Many", + "contains-other-v": "${direction}", + "delete-other-v": "NONE", + "SVC-INFRA": "${direction}", "prevent-delete": "NONE" } ] diff --git a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test_broken.json b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test_broken.json index d4b7f7f3..f9d401f2 100644 --- a/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test_broken.json +++ b/aai-core/src/test/resources/dbedgerules/DbEdgeRules_test_broken.json @@ -8,7 +8,8 @@ "multiplicity": "One2Many", "contains-other-v": "NONE", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "foo", @@ -19,7 +20,8 @@ "contains-other-v": "${direction}", "delete-other-v": "${direction}", "SVC-INFRA": "NONE", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" }, { "from": "quux", @@ -29,7 +31,8 @@ "multiplicity": "One2Many", "contains-other-v": "!${direction}", "delete-other-v": "${direction}", - "prevent-delete": "NONE" + "prevent-delete": "NONE", + "description": "Hard to describe" } ] } \ No newline at end of file diff --git a/aai-core/src/test/resources/edgeLabelMigration.csv b/aai-core/src/test/resources/edgeLabelMigration.csv new file mode 100644 index 00000000..53639e55 --- /dev/null +++ b/aai-core/src/test/resources/edgeLabelMigration.csv @@ -0,0 +1,212 @@ +from,to,label,direction,multiplicity,contains-other-v,delete-other-v,SVC-INFRA,prevent-delete,new from,new to,new label,new direction,new multiplicity,new contains-other-v,new delete-other-v,new SVC-INFRA,new prevent-delete,new default +allotted-resource,allotted-resource,bindsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,allotted-resource,allotted-resource,tosca.relationships.network.BindsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +allotted-resource,generic-vnf,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,generic-vnf,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,l3-network,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,l3-network,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,l-interface,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,allotted-resource,l-interface,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,network-policy,uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,allotted-resource,network-policy,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +allotted-resource,vlan,isPartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,allotted-resource,vlan,org.onap.relationships.inventory.PartOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +allotted-resource,vpn-binding,belongsTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},allotted-resource,vpn-binding,org.onap.relationships.inventory.BelongsTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +allotted-resource,tunnel-xconnect,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,tunnel-xconnect,allotted-resource,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +availability-zone,complex,groupsResourcesIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},availability-zone,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +availability-zone,service-capability,supportsServiceCapability,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},availability-zone,service-capability,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +cloud-region,availability-zone,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},availability-zone,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +cloud-region,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},cloud-region,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +cloud-region,l3-network,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,cloud-region,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +cloud-region,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,cloud-region,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +cloud-region,dvs-switch,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},dvs-switch,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,flavor,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},flavor,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,group-assignment,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},group-assignment,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,image,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},image,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,oam-network,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},oam-network,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,snapshot,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},snapshot,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,tenant,has,OUT,ONE2MANY,${direction},${direction},!${direction},${direction},tenant,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,${direction},!${direction},T +cloud-region,vip-ipv4-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vip-ipv4-address-list,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,vip-ipv6-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vip-ipv6-address-list,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +cloud-region,volume-group,has,OUT,ONE2MANY,${direction},${direction},NONE,${direction},volume-group,cloud-region,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,NONE,!${direction},T +complex,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,${direction},NONE,complex,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +complex,ctag-pool,hasCtagPool,OUT,MANY2MANY,${direction},${direction},NONE,NONE,ctag-pool,complex,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +configuration,allotted-resource,uses,OUT,ONE2ONE,NONE,${direction},NONE,NONE,configuration,allotted-resource,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,${direction},NONE,NONE,T +configuration,logical-link,has,OUT,ONE2MANY,NONE,${direction},NONE,NONE,configuration,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +configuration,metadatum,owns,OUT,ONE2MANY,${direction},${direction},NONE,NONE,metadatum,configuration,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +connector,virtual-data-center,contains,OUT,MANY2MANY,NONE,NONE,NONE,NONE,connector,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +connector,metadatum,hasMetaData,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,connector,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +constrained-element-set,element-choice-set,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,element-choice-set,constrained-element-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +ctag-pool,availability-zone,supportsAvailabilityZone,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},ctag-pool,availability-zone,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +customer,service-subscription,subscribesTo,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,service-subscription,customer,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +dvs-switch,availability-zone,existsIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},dvs-switch,availability-zone,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +element-choice-set,model-element,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,element-choice-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,entitlement,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,entitlement,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,availability-zone,hasAvailabilityZone,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},generic-vnf,availability-zone,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +generic-vnf,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},generic-vnf,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +generic-vnf,configuration,uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,generic-vnf,configuration,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +generic-vnf,ctag-pool,usesCtagPool,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,ctag-pool,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,ipsec-configuration,uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,generic-vnf,ipsec-configuration,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +generic-vnf,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,${direction},NONE,generic-vnf,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,license-key-resource,uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},generic-vnf,license-key-resource,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +generic-vnf,pnf,hostedOn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,generic-vnf,pnf,tosca.relationships.HostedOn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,pserver,runsOnPserver,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},generic-vnf,pserver,tosca.relationships.HostedOn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +generic-vnf,vnfc,uses,OUT,ONE2MANY,NONE,${direction},${direction},NONE,vnfc,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,NONE,!${direction},!${direction},NONE,T +generic-vnf,vnf-image,usesVnfImage,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},generic-vnf,vnf-image,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +generic-vnf,volume-group,uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,generic-vnf,volume-group,org.onap.relationships.inventory.DependsOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,vserver,runsOnVserver,OUT,ONE2MANY,NONE,NONE,${direction},NONE,generic-vnf,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +generic-vnf,lag-interface,hasLAGInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,lag-interface,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +generic-vnf,license,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,license,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +generic-vnf,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +generic-vnf,network-profile,hasNetworkProfile,OUT,MANY2MANY,NONE,NONE,NONE,NONE,network-profile,generic-vnf,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,service-instance,hasInstance,OUT,MANY2MANY,NONE,NONE,${direction},NONE,service-instance,generic-vnf,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +generic-vnf,site-pair-set,hasSitePairSet,OUT,MANY2MANY,NONE,NONE,NONE,NONE,site-pair-set,generic-vnf,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +generic-vnf,vf-module,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,vf-module,generic-vnf,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +group-assignment,pserver,has,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},pserver,group-assignment,org.onap.relationships.inventory.MemberOf,OUT,MANY2ONE,NONE,NONE,NONE,${direction},T +group-assignment,tenant,has,OUT,MANY2MANY,NONE,NONE,NONE,NONE,tenant,group-assignment,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +image,metadatum,hasMetaDatum,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,image,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +instance-group,model,targets,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},instance-group,model,org.onap.relationships.inventory.Targets,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +ipsec-configuration,vig-server,hasVigServer,OUT,ONE2MANY,${direction},${direction},NONE,NONE,vig-server,ipsec-configuration,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +l3-interface-ipv4-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-interface-ipv4-address-list,instance-group,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-interface-ipv4-address-list,l3-network,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-interface-ipv4-address-list,l3-network,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-interface-ipv4-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},l3-interface-ipv4-address-list,subnet,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +l3-interface-ipv6-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-interface-ipv6-address-list,instance-group,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-interface-ipv6-address-list,l3-network,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-interface-ipv6-address-list,l3-network,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-interface-ipv6-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},l3-interface-ipv6-address-list,subnet,org.onap.relationships.inventory.network.MemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +l3-network,ctag-assignment,hasCtagAssignment,OUT,MANY2MANY,${direction},${direction},${direction},NONE,ctag-assignment,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l3-network,instance-group,memberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-network,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-network,network-policy,uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,l3-network,network-policy,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +l3-network,route-table-reference,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l3-network,route-table-reference,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l3-network,vpn-binding,usesVpnBinding,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},l3-network,vpn-binding,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +l3-network,segmentation-assignment,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,segmentation-assignment,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +l3-network,service-instance,hasInstance,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,service-instance,l3-network,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +l3-network,subnet,hasSubnet,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,subnet,l3-network,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +lag-interface,lag-link,usesLAGLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,lag-interface,lag-link,tosca.relationships.network.LinksTo,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +lag-interface,logical-link,uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,lag-interface,logical-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +lag-interface,p-interface,usesPInterface,OUT,MANY2MANY,NONE,NONE,${direction},NONE,lag-interface,p-interface,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +lag-interface,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,lag-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +line-of-business,generic-vnf,realizedBy,OUT,MANY2MANY,NONE,NONE,NONE,NONE,line-of-business,generic-vnf,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l-interface,l3-interface-ipv4-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv4-address-list,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,l3-interface-ipv6-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv6-address-list,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,l-interface,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +l-interface,l-interface,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,l-interface,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +l-interface,logical-link,usesLogicalLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,l-interface,logical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,${direction},${direction},NONE,T +l-interface,logical-link,sourceLInterface,OUT,MANY2MANY,NONE,${direction},${direction},NONE,logical-link,l-interface,org.onap.relationships.inventory.Source,OUT,ONE2MANY,NONE,!${direction},!${direction},NONE,F +l-interface,logical-link,targetLInterface,OUT,MANY2MANY,NONE,${direction},${direction},NONE,logical-link,l-interface,org.onap.relationships.inventory.Destination,OUT,ONE2MANY,NONE,!${direction},!${direction},NONE,F +l-interface,sriov-vf,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,sriov-vf,l-interface,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +l-interface,vlan,hasVlan,OUT,MANY2MANY,${direction},${direction},NONE,NONE,vlan,l-interface,tosca.relationships.network.LinksTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +logical-link,cloud-region,existsIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,cloud-region,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,generic-vnf,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,generic-vnf,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,lag-link,usesLAGLink,OUT,MANY2MANY,NONE,NONE,${direction},NONE,logical-link,lag-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +logical-link,logical-link,uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,logical-link,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +logical-link,pnf,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,pnf,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +logical-link,pserver,bridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},logical-link,pserver,org.onap.relationships.inventory.BridgedTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +logical-link,vpn-binding,uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},logical-link,vpn-binding,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +model,model-ver,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-ver,model,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-constraint,constrained-element-set,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,constrained-element-set,model-constraint,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,constrained-element-set,connectsTo,OUT,ONE2MANY,${direction},${direction},NONE,NONE,constrained-element-set,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-constraint,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-constraint,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-element,connectsTo,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,model-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-element,model-ver,isA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},model-element,model-ver,org.onap.relationships.inventory.IsA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +model-ver,metadatum,hasMetaDatum,OUT,ONE2MANY,${direction},${direction},NONE,NONE,metadatum,model-ver,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +model-ver,model-element,startsWith,OUT,ONE2MANY,${direction},${direction},NONE,NONE,model-element,model-ver,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query,model,relatedTo,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},named-query,model,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,!${direction},T +named-query,named-query-element,startsWith,OUT,ONE2ONE,${direction},${direction},NONE,NONE,named-query-element,named-query,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,model,isA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},named-query-element,model,org.onap.relationships.inventory.IsA,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +named-query-element,named-query-element,connectsTo,OUT,MANY2MANY,${direction},${direction},NONE,NONE,named-query-element,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,property-constraint,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,property-constraint,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +named-query-element,related-lookup,uses,OUT,ONE2MANY,${direction},${direction},NONE,NONE,related-lookup,named-query-element,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +newvce,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,l-interface,newvce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +oam-network,complex,definedFor,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},oam-network,complex,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +oam-network,service-capability,supportsServiceCapability,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},oam-network,service-capability,org.onap.relationships.inventory.AppliesTo,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +operational-environment,operational-environment,managedBy,OUT,ONE2ONE,NONE,NONE,NONE,NONE,operational-environment,operational-environment,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +owning-entity,service-instance,owns,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,owning-entity,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +p-interface,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,p-interface,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +p-interface,logical-link,usesLogicalLink,OUT,MANY2ONE,NONE,NONE,${direction},NONE,p-interface,logical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +p-interface,physical-link,usesPhysicalLink,OUT,MANY2MANY,NONE,${direction},NONE,NONE,p-interface,physical-link,tosca.relationships.network.LinksTo,OUT,MANY2ONE,NONE,${direction},NONE,NONE,T +p-interface,sriov-pf,has,OUT,ONE2ONE,${direction},${direction},NONE,NONE,sriov-pf,p-interface,org.onap.relationships.inventory.BelongsTo,OUT,ONE2ONE,!${direction},!${direction},NONE,NONE,T +platform,generic-vnf,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,platform,generic-vnf,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +pnf,lag-interface,has,OUT,ONE2MANY,${direction},${direction},${direction},NONE,lag-interface,pnf,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pnf,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,p-interface,pnf,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pnf,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},pnf,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +pnf,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,pnf,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +pnf,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,pnf,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +port-group,cvlan-tag,hasCTag,OUT,MANY2MANY,${direction},${direction},${direction},NONE,cvlan-tag,port-group,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +project,service-instance,created,OUT,ONE2MANY,NONE,NONE,NONE,NONE,project,service-instance,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +pserver,lag-interface,hasLAGInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,lag-interface,pserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pserver,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,p-interface,pserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +pserver,availability-zone,existsIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},pserver,availability-zone,org.onap.relationships.inventory.MemberOf,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +pserver,cloud-region,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,pserver,cloud-region,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +pserver,complex,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},pserver,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +pserver,zone,isMemberOf,OUT,MANY2ONE,NONE,NONE,NONE,NONE,pserver,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +routing-instance,site-pair,hasSitePair,OUT,MANY2MANY,${direction},${direction},NONE,NONE,site-pair,routing-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,allotted-resource,has,OUT,MANY2MANY,${direction},${direction},NONE,NONE,allotted-resource,service-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,metadatum,hasMetaData,OUT,MANY2MANY,${direction},${direction},NONE,NONE,metadatum,service-instance,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +service-instance,allotted-resource,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,allotted-resource,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,configuration,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,configuration,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,connector,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,connector,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,ctag-assignment,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,ctag-assignment,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,cvlan-tag,hasIPAGFacingVLAN,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,cvlan-tag,org.onap.relationships.inventory.ComposedOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-instance,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +service-instance,logical-link,uses,OUT,MANY2MANY,NONE,${direction},NONE,NONE,service-instance,logical-link,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,${direction},NONE,NONE,T +service-instance,pnf,uses,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,pnf,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,service-instance,dependsOn,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,service-instance,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,vlan,dependsOn,OUT,ONE2MANY,NONE,NONE,NONE,NONE,service-instance,vlan,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +service-instance,zone,locatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,service-instance,zone,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},NONE,T +service-subscription,service-instance,hasInstance,OUT,MANY2MANY,${direction},${direction},!${direction},NONE,service-instance,service-subscription,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},${direction},NONE,T +site-pair,class-of-service,hasClassOfService,OUT,MANY2MANY,${direction},${direction},NONE,NONE,class-of-service,site-pair,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +site-pair-set,routing-instance,hasRoutingInstance,OUT,MANY2MANY,${direction},${direction},NONE,NONE,routing-instance,site-pair-set,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +sriov-vf,sriov-pf,uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,sriov-vf,sriov-pf,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,NONE,NONE,T +subnet,host-route,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,host-route,subnet,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +tenant,service-subscription,relatedTo,OUT,MANY2MANY,NONE,NONE,NONE,NONE,service-subscription,tenant,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +tenant,l3-network,usesL3Network,OUT,MANY2MANY,NONE,NONE,NONE,NONE,tenant,l3-network,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +tenant,vserver,owns,OUT,ONE2MANY,${direction},${direction},!${direction},${direction},vserver,tenant,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},NONE,${direction},!${direction},T +vce,entitlement,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,entitlement,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vce,license,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,license,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vce,port-group,hasPortGroup,OUT,MANY2MANY,${direction},${direction},${direction},NONE,port-group,vce,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vce,service-instance,hasServiceInstance,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,service-instance,vce,org.onap.relationships.inventory.ComposedOf,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +vce,availability-zone,hasAvailabilityZone,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},vce,availability-zone,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +vce,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vce,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},T +vce,vserver,runsOnVserver,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vce,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,${direction},NONE,T +vf-module,l3-network,uses,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vf-module,l3-network,org.onap.relationships.inventory.DependsOn,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +vf-module,vnfc,uses,OUT,ONE2MANY,NONE,${direction},${direction},${direction},vf-module,vnfc,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,${direction},${direction},T +vf-module,volume-group,uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,vf-module,volume-group,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,T +vip-ipv4-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vip-ipv4-address-list,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vip-ipv4-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vip-ipv4-address-list,subnet,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +vip-ipv6-address-list,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vip-ipv6-address-list,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vip-ipv6-address-list,subnet,isMemberOf,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},vip-ipv6-address-list,subnet,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},T +virtual-data-center,generic-vnf,hasVNF,OUT,MANY2MANY,NONE,NONE,!${direction},NONE,generic-vnf,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,${direction},NONE,T +virtual-data-center,logical-link,contains,OUT,MANY2MANY,NONE,NONE,NONE,NONE,logical-link,virtual-data-center,org.onap.relationships.inventory.LocatedIn,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vlan,l3-interface-ipv4-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv4-address-list,vlan,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vlan,l3-interface-ipv6-address-list,hasIpAddress,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l3-interface-ipv6-address-list,vlan,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vlan,logical-link,usesLogicalLink,OUT,MANY2MANY,NONE,${direction},${direction},NONE,vlan,logical-link,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,${direction},${direction},NONE,T +vlan,multicast-configuration,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vlan,multicast-configuration,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,l3-interface-ipv4-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},NONE,NONE,l3-interface-ipv4-address-list,vnfc,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vnfc,l3-interface-ipv6-address-list,hasIpAddress,OUT,ONE2MANY,${direction},${direction},NONE,NONE,l3-interface-ipv6-address-list,vnfc,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vnfc,instance-group,isMemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,instance-group,org.onap.relationships.inventory.MemberOf,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,vip-ipv4-address-list,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,vip-ipv4-address-list,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vnfc,vip-ipv6-address-list,uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vnfc,vip-ipv6-address-list,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +volume-group,tenant,belongsTo,OUT,MANY2MANY,NONE,NONE,${direction},NONE,tenant,volume-group,org.onap.relationships.inventory.DependsOn,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +volume-group,complex,existsIn,OUT,MANY2MANY,NONE,NONE,${direction},!${direction},volume-group,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vpls-pe,lag-interface,hasLAGinterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,lag-interface,vpls-pe,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vpls-pe,p-interface,hasPinterface,OUT,MANY2MANY,${direction},${direction},NONE,NONE,p-interface,vpls-pe,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vpls-pe,complex,locatedIn,OUT,MANY2MANY,NONE,NONE,NONE,!${direction},vpls-pe,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +vpls-pe,ctag-pool,usesCtagPool,OUT,MANY2MANY,NONE,NONE,NONE,NONE,vpls-pe,ctag-pool,org.onap.relationships.inventory.Uses,OUT,MANY2MANY,NONE,NONE,NONE,NONE,T +vpn-binding,route-target,has,OUT,ONE2MANY,${direction},${direction},NONE,NONE,route-target,vpn-binding,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +vserver,l-interface,hasLInterface,OUT,MANY2MANY,${direction},${direction},${direction},NONE,l-interface,vserver,tosca.relationships.network.BindsTo,OUT,MANY2ONE,!${direction},!${direction},!${direction},NONE,T +vserver,vf-module,isPartOf,OUT,MANY2ONE,NONE,NONE,${direction},NONE,vf-module,vserver,org.onap.relationships.inventory.Uses,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +vserver,vnfc,hosts,OUT,MANY2MANY,NONE,NONE,${direction},NONE,vnfc,vserver,tosca.relationships.HostedOn,OUT,ONE2MANY,NONE,NONE,!${direction},NONE,T +vserver,flavor,hasFlavor,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,flavor,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,image,hasImage,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,image,org.onap.relationships.inventory.Uses,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,pserver,runsOnPserver,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},vserver,pserver,tosca.relationships.HostedOn,OUT,MANY2ONE,NONE,NONE,${direction},!${direction},T +vserver,snapshot,uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,vserver,snapshot,org.onap.relationships.inventory.Uses,OUT,ONE2ONE,NONE,NONE,${direction},NONE,T +vserver,volume,hasVolume,OUT,MANY2MANY,${direction},${direction},${direction},NONE,vserver,volume,tosca.relationships.AttachesTo,OUT,ONE2MANY,${direction},${direction},${direction},NONE,T +zone,complex,existsIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},zone,complex,org.onap.relationships.inventory.LocatedIn,OUT,MANY2ONE,NONE,NONE,NONE,!${direction},T +,,,,,,,,,allotted-resource,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,generic-vnf,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,l3-network,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,logical-link,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,service-instance,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +,,,,,,,,,vf-module,model-ver,org.onap.relationships.inventory.IsA,OUT,Many2One,NONE,NONE,NONE,NONE,T +configuration,l-interface,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,configuration,l-interface,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +configuration,pnf,has,OUT,ONE2MANY,NONE,NONE,NONE,NONE,configuration,pnf,org.onap.relationships.inventory.AppliesTo,OUT,ONE2MANY,NONE,NONE,NONE,NONE,T +forwarder,forwarding-path,belongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,forwarder,forwarding-path,org.onap.relationships.inventory.BelongsTo,OUT,MANY2ONE,!${direction},!${direction},NONE,NONE,T +forwarding-path,service-instance,implements,OUT,MANY2ONE,NONE,!${direction},NONE,NONE,forwarding-path,service-instance,org.onap.relationships.inventory.AppliesTo,OUT,MANY2ONE,NONE,!${direction},NONE,NONE,T +forwarder,l-interface,forwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,forwarder,l-interface,org.onap.relationships.inventory.ForwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T +forwarder,p-interface,forwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,forwarder,p-interface,org.onap.relationships.inventory.ForwardsTo,OUT,ONE2ONE,NONE,NONE,NONE,NONE,T diff --git a/aai-core/src/test/resources/logback.xml b/aai-core/src/test/resources/logback.xml index 959ef63f..37425b97 100644 --- a/aai-core/src/test/resources/logback.xml +++ b/aai-core/src/test/resources/logback.xml @@ -130,7 +130,7 @@ ${logDirectory}/rest/audit.log - ${logDirectory}/rest/audit-${Pid}.%d{yyyy-MM-dd}.log.zip + ${logDirectory}/rest/audit-${lrmRVer}-${lrmRO}-${Pid}.%d{yyyy-MM-dd}.log.zip ${logDirectory}/rest/perform.log - ${logDirectory}/rest/perform-${Pid}.%d{yyyy-MM-dd}.log.zip + ${logDirectory}/rest/perform-${lrmRVer}-${lrmRO}-${Pid}.%d{yyyy-MM-dd}.log.zip - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v8.xml b/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v8.xml deleted file mode 100644 index 06dc6e03..00000000 --- a/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v8.xml +++ /dev/null @@ -1,3079 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v9.xml b/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v9.xml deleted file mode 100644 index aec9b83d..00000000 --- a/aai-core/src/test/resources/org/openecomp/aai/introspection/aai_oxm_v9.xml +++ /dev/null @@ -1,599 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/aai-core/src/test/resources/payloads/expected/generic-vnf-with-lag-interface.json b/aai-core/src/test/resources/payloads/expected/generic-vnf-with-lag-interface.json new file mode 100644 index 00000000..3c656da1 --- /dev/null +++ b/aai-core/src/test/resources/payloads/expected/generic-vnf-with-lag-interface.json @@ -0,0 +1,27 @@ +{ + "vnf-id": "vnf1", + "vnf-type": "someval", + "vnf-name": "someval", + "lag-interfaces": { + "lag-interface": [ + { + "interface-name": "lag1", + "l-interfaces": { + "l-interface": [ + { + "interface-name": "int1", + "l3-interface-ipv6-address-list": [ + { + "l3-interface-ipv6-address": "ipv1" + }, + { + "l3-interface-ipv6-address": "ipv2" + } + ] + } + ] + } + } + ] + } +} diff --git a/aai-core/src/test/resources/payloads/resource/cloud-region-with-all-children.json b/aai-core/src/test/resources/payloads/resource/cloud-region-with-all-children.json new file mode 100644 index 00000000..97372dd8 --- /dev/null +++ b/aai-core/src/test/resources/payloads/resource/cloud-region-with-all-children.json @@ -0,0 +1,310 @@ +{ + "cloud-owner" : "junit-cloud-owner", + "cloud-region-id" : "junit-cloud-region", + "cloud-type" : "P9P1X6U9eDXR", + "owner-defined-type" : "OUrR8kI6Br", + "cloud-region-version" : "Nyr", + "identity-url" : "JHqvA1M", + "cloud-zone" : "Y5UfJUM", + "complex-name" : "QLP", + "sriov-automation" : false, + "tenants" : { + "tenant" : [ { + "tenant-id" : "tenant1", + "tenant-name" : "yhgVBcv3Pr", + "tenant-context" : "De4NNayqFBO", + "vservers" : { + "vserver" : [ { + "vserver-id" : "vserver1", + "vserver-name" : "P3SJ347Uyv", + "vserver-name2" : "1dHd", + "prov-status" : "PR04shorWQ", + "vserver-selflink" : "v7dU8H", + "in-maint" : false, + "is-closed-loop-disabled" : true, + "volumes" : { + "volume" : [ { + "volume-id" : "61cbb17e-8e5f-4545-a8ea-13a0e9c9871f-vk250x", + "volume-selflink" : "mYkfJ9rGv" + }, { + "volume-id" : "d98083a6-b235-4e54-b19b-2ebfa1604246-vk250x", + "volume-selflink" : "69RRsreL4" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "top-linterface", + "interface-role" : "3W1FAJGSQ", + "v6-wan-link-ip" : "WugWw3N", + "selflink" : "Of4j0pU", + "interface-id" : "eoW", + "macaddr" : "XNbbIy33", + "network-name" : "ZETDv5sGhiS", + "management-option" : "qR3RyCxgEU", + "interface-description" : "ksuRPpWDEH7", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "20Q0ZE6n5iB0", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "KjPXyH", + "vlans" : { + "vlan" : [ { + "vlan-interface" : "8d225c33-7494-4173-939f-0e1e8741344d-vk250x", + "vlan-id-inner" : 884, + "vlan-id-outer" : 992, + "speed-value" : "RyFPm", + "speed-units" : "ZrckmLff7b", + "vlan-description" : "zjAeUFgeagpf", + "backdoor-connection" : "gANMvUquB", + "vpn-key" : "l0rV7bb2Sc", + "orchestration-status" : "WVnLpbzIx", + "in-maint" : false, + "prov-status" : "tYMRi6df", + "is-ip-unnumbered" : false, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "2e7d62a5-ff93-446f-9fa3-b4ba585e742b-vk250x", + "l3-interface-ipv4-prefix-length" : 640, + "vlan-id-inner" : 652, + "vlan-id-outer" : 868, + "is-floating" : true, + "neutron-network-id" : "dJ8Fqs4ZTRn", + "neutron-subnet-id" : "HC6ji9DO8" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "818cd2e5-8dac-4a49-aa2e-4f97d4e98594-vk250x", + "l3-interface-ipv6-prefix-length" : 910, + "vlan-id-inner" : 116, + "vlan-id-outer" : 661, + "is-floating" : true, + "neutron-network-id" : "vSpYqFg5Tfe", + "neutron-subnet-id" : "bqkOUZSlVF" + }, { + "l3-interface-ipv6-address" : "915a8e5d-9d39-4f99-a350-c48f48ac8f46-vk250x", + "l3-interface-ipv6-prefix-length" : 593, + "vlan-id-inner" : 554, + "vlan-id-outer" : 762, + "is-floating" : false, + "neutron-network-id" : "b7PM", + "neutron-subnet-id" : "u51Ma93" + } ] + } ] + }, + "sriov-vfs" : { + "sriov-vf" : [ { + "pci-id" : "01ca7dbe-e270-4545-a045-72e9e3fcb44b-vk250x", + "vf-vlan-filter" : "f9YNFlqrfHi", + "vf-mac-filter" : "HQhFdXpL1v", + "vf-vlan-strip" : true, + "vf-vlan-anti-spoof-check" : false, + "vf-mac-anti-spoof-check" : false, + "vf-mirrors" : "SqknCX", + "vf-broadcast-allow" : true, + "vf-unknown-multicast-allow" : false, + "vf-unknown-unicast-allow" : false, + "vf-insert-stag" : true, + "vf-link-status" : "MsSX9hug4u1", + "neutron-network-id" : "f4jq6yFxVVtC" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "nested-linterface1", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + },{ + "interface-name" : "nested-linterface2", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + } ] + }, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "fc25fa49-ec46-43f5-bd39-c1c9067d2962-vk250x", + "l3-interface-ipv4-prefix-length" : 339, + "vlan-id-inner" : 644, + "vlan-id-outer" : 701, + "is-floating" : true, + "neutron-network-id" : "IEpYVl", + "neutron-subnet-id" : "7uWdipdgtC4Qc" + }, { + "l3-interface-ipv4-address" : "402d29fe-baf4-47e3-9208-e12a75e25349-vk250x", + "l3-interface-ipv4-prefix-length" : 370, + "vlan-id-inner" : 971, + "vlan-id-outer" : 142, + "is-floating" : false, + "neutron-network-id" : "sRi62ZY3IrKkq", + "neutron-subnet-id" : "PeV5RhIfV2Ib7" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "c9befce1-5617-4525-b217-105a57f6bd59-vk250x", + "l3-interface-ipv6-prefix-length" : 333, + "vlan-id-inner" : 275, + "vlan-id-outer" : 324, + "is-floating" : true, + "neutron-network-id" : "em6Lc6ovvWsdx", + "neutron-subnet-id" : "pyx4f" + }, { + "l3-interface-ipv6-address" : "18aa594c-143b-4564-ac0c-72144aecbb66-vk250x", + "l3-interface-ipv6-prefix-length" : 350, + "vlan-id-inner" : 893, + "vlan-id-outer" : 37, + "is-floating" : false, + "neutron-network-id" : "lhiR1", + "neutron-subnet-id" : "kdfoiCb7JYBuh" + } ] + } ] + } + } ] + } + } ] + }, + "flavors" : { + "flavor" : [ { + "flavor-id" : "a7208e23-b517-4ccb-a3ab-00952aa89480-vk250x", + "flavor-name" : "JGWnOD", + "flavor-vcpus" : 803, + "flavor-ram" : 920, + "flavor-disk" : 438, + "flavor-ephemeral" : 41, + "flavor-swap" : "KiuHc7", + "flavor-is-public" : false, + "flavor-selflink" : "pXtX", + "flavor-disabled" : false + } ] + }, + "group-assignments" : { + "group-assignment" : [ { + "group-id" : "30c1bb60-1b71-4b46-910f-d33c7905a779-vk250x", + "group-type" : "bRh", + "group-name" : "hg11sdvW", + "group-description" : "df3w60RR" + } ] + }, + "snapshots" : { + "snapshot" : [ { + "snapshot-id" : "26c013f4-c119-4ddd-89cf-e9b2729f87e5-vk250x", + "snapshot-name" : "0J3q8ZjyPGH", + "snapshot-architecture" : "wMu9Tvile", + "snapshot-os-distro" : "2Vv4Pqzu", + "snapshot-os-version" : "Vim0fyf404YVW", + "application" : "oxkCtHUk", + "application-vendor" : "tTpXkD", + "application-version" : "aOqn", + "snapshot-selflink" : "GCapKV9Tq", + "prev-snapshot-id" : "Imnj21xW5Hez" + }, { + "snapshot-id" : "ee2e8769-2dcf-4a3c-90bd-a0ba91c97f13-vk250x", + "snapshot-name" : "zRh94rw3pc1", + "snapshot-architecture" : "FxVDY", + "snapshot-os-distro" : "QZnKXjI5LDBSi", + "snapshot-os-version" : "u0Bl2moOJ7bb", + "application" : "dlXZPm9B7", + "application-vendor" : "89tls6", + "application-version" : "c05X", + "snapshot-selflink" : "rmExWmnDIZu3", + "prev-snapshot-id" : "5chZxlmHfhe" + } ] + }, + "images" : { + "image" : [ { + "image-id" : "691210f6-f3f2-488f-993c-a9c9570fb71f-vk250x", + "image-name" : "GsPzYlduuWk", + "image-architecture" : "vNdK4fYJf", + "image-os-distro" : "ZxYe", + "image-os-version" : "SVBBpHEc", + "application" : "GgBxi1zv8h2KG", + "application-vendor" : "x6NtDNUj", + "application-version" : "VOZYqE04K9", + "image-selflink" : "gOzbbHZtkuh", + "metadata" : { + "metadatum" : [ { + "metaname" : "b9565dfa-ed1f-4d35-90c6-bb56a48d9b2a-vk250x", + "metaval" : "nyq5IHmI" + } ] + } + }, { + "image-id" : "1f00c00a-9ab7-44a0-9961-bcf5f806fef8-vk250x", + "image-name" : "WChNCg3ThQ1Of", + "image-architecture" : "oL2m4nUPPG6j", + "image-os-distro" : "kf7", + "image-os-version" : "DxTTyv4S16e", + "application" : "Y0dytCJ2ouDk", + "application-vendor" : "F7E7a", + "application-version" : "8wkd3Cy", + "image-selflink" : "5N5A", + "metadata" : { + "metadatum" : [ { + "metaname" : "a5c4c98f-0b36-4f70-a235-5135e8e644f1-vk250x", + "metaval" : "vupk3k29rdN" + }, { + "metaname" : "e6084e48-df73-4854-a2be-522087b5f6a3-vk250x", + "metaval" : "l9VaEeP" + } ] + } + } ] + }, + "dvs-switches" : { + "dvs-switch" : [ { + "switch-name" : "b01222d9-f9f9-493d-8ee0-9ab7c095d5a0-vk250x", + "vcenter-url" : "NNtc" + }, { + "switch-name" : "7abed153-9fb5-4c05-87aa-ead0feb35b16-vk250x", + "vcenter-url" : "YSS" + } ] + }, + "oam-networks" : { + "oam-network" : [ { + "network-uuid" : "af2371f8-0fa6-4d4d-90c8-9c5d3ba3e01e-vk250x", + "network-name" : "cVevT9o20HAs4", + "cvlan-tag" : 560, + "ipv4-oam-gateway-address" : "F565rGb", + "ipv4-oam-gateway-address-prefix-length" : 540 + } ] + }, + "availability-zones" : { + "availability-zone" : [ { + "availability-zone-name" : "9761e922-fd2a-4c96-9a13-4e62e1daccdc-vk250x", + "hypervisor-type" : "qijdeI", + "operational-status" : "C0KkUiJ" + } ] + }, + "vip-ipv4-address-list" : [ { + "vip-ipv4-address" : "08b4a6c1-c702-4449-8791-caaa5341c6d9-vk250x", + "vip-ipv4-prefix-length" : 185, + "vlan-id-inner" : 969, + "vlan-id-outer" : 414, + "is-floating" : true, + "neutron-network-id" : "S7r90cEZ", + "neutron-subnet-id" : "2NwjH" + } ], + "vip-ipv6-address-list" : [ { + "vip-ipv6-address" : "f01dbad0-10c5-491c-a6e5-d972c9b99f56-vk250x", + "vip-ipv6-prefix-length" : 365, + "vlan-id-inner" : 326, + "vlan-id-outer" : 927, + "is-floating" : true, + "neutron-network-id" : "ULEl0", + "neutron-subnet-id" : "eyt9" + } ] +} \ No newline at end of file diff --git a/aai-core/src/test/resources/payloads/resource/l-interface-with-ipv6.json b/aai-core/src/test/resources/payloads/resource/l-interface-with-ipv6.json new file mode 100644 index 00000000..fee82181 --- /dev/null +++ b/aai-core/src/test/resources/payloads/resource/l-interface-with-ipv6.json @@ -0,0 +1,22 @@ +{ + "vnf-id": "vnf1", + "lag-interfaces": { + "lag-interface": [ + { + "interface-name": "lag1", + "l-interfaces": { + "l-interface": [ + { + "interface-name": "int1", + "l3-interface-ipv6-address-list": [ + { + "l3-interface-ipv6-address": "ipv6-1" + } + ] + } + ] + } + } + ] + } +} diff --git a/aai-core/src/test/resources/payloads/templates/cloud-region.json b/aai-core/src/test/resources/payloads/templates/cloud-region.json new file mode 100644 index 00000000..176214af --- /dev/null +++ b/aai-core/src/test/resources/payloads/templates/cloud-region.json @@ -0,0 +1,310 @@ +{ + "cloud-owner" : "${cloud-owner}", + "cloud-region-id" : "${cloud-region-id}", + "cloud-type" : "P9P1X6U9eDXR", + "owner-defined-type" : "OUrR8kI6Br", + "cloud-region-version" : "Nyr", + "identity-url" : "JHqvA1M", + "cloud-zone" : "Y5UfJUM", + "complex-name" : "QLP", + "sriov-automation" : false, + "tenants" : { + "tenant" : [ { + "tenant-id" : "${tenant-id}", + "tenant-name" : "yhgVBcv3Pr", + "tenant-context" : "De4NNayqFBO", + "vservers" : { + "vserver" : [ { + "vserver-id" : "${vserver-id}", + "vserver-name" : "P3SJ347Uyv", + "vserver-name2" : "1dHd", + "prov-status" : "PR04shorWQ", + "vserver-selflink" : "v7dU8H", + "in-maint" : false, + "is-closed-loop-disabled" : true, + "volumes" : { + "volume" : [ { + "volume-id" : "61cbb17e-8e5f-4545-a8ea-13a0e9c9871f-vk250x", + "volume-selflink" : "mYkfJ9rGv" + }, { + "volume-id" : "d98083a6-b235-4e54-b19b-2ebfa1604246-vk250x", + "volume-selflink" : "69RRsreL4" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "top-linterface", + "interface-role" : "3W1FAJGSQ", + "v6-wan-link-ip" : "WugWw3N", + "selflink" : "Of4j0pU", + "interface-id" : "eoW", + "macaddr" : "XNbbIy33", + "network-name" : "ZETDv5sGhiS", + "management-option" : "qR3RyCxgEU", + "interface-description" : "ksuRPpWDEH7", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "20Q0ZE6n5iB0", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "KjPXyH", + "vlans" : { + "vlan" : [ { + "vlan-interface" : "8d225c33-7494-4173-939f-0e1e8741344d-vk250x", + "vlan-id-inner" : 884, + "vlan-id-outer" : 992, + "speed-value" : "RyFPm", + "speed-units" : "ZrckmLff7b", + "vlan-description" : "zjAeUFgeagpf", + "backdoor-connection" : "gANMvUquB", + "vpn-key" : "l0rV7bb2Sc", + "orchestration-status" : "WVnLpbzIx", + "in-maint" : false, + "prov-status" : "tYMRi6df", + "is-ip-unnumbered" : false, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "2e7d62a5-ff93-446f-9fa3-b4ba585e742b-vk250x", + "l3-interface-ipv4-prefix-length" : 640, + "vlan-id-inner" : 652, + "vlan-id-outer" : 868, + "is-floating" : true, + "neutron-network-id" : "dJ8Fqs4ZTRn", + "neutron-subnet-id" : "HC6ji9DO8" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "818cd2e5-8dac-4a49-aa2e-4f97d4e98594-vk250x", + "l3-interface-ipv6-prefix-length" : 910, + "vlan-id-inner" : 116, + "vlan-id-outer" : 661, + "is-floating" : true, + "neutron-network-id" : "vSpYqFg5Tfe", + "neutron-subnet-id" : "bqkOUZSlVF" + }, { + "l3-interface-ipv6-address" : "915a8e5d-9d39-4f99-a350-c48f48ac8f46-vk250x", + "l3-interface-ipv6-prefix-length" : 593, + "vlan-id-inner" : 554, + "vlan-id-outer" : 762, + "is-floating" : false, + "neutron-network-id" : "b7PM", + "neutron-subnet-id" : "u51Ma93" + } ] + } ] + }, + "sriov-vfs" : { + "sriov-vf" : [ { + "pci-id" : "01ca7dbe-e270-4545-a045-72e9e3fcb44b-vk250x", + "vf-vlan-filter" : "f9YNFlqrfHi", + "vf-mac-filter" : "HQhFdXpL1v", + "vf-vlan-strip" : true, + "vf-vlan-anti-spoof-check" : false, + "vf-mac-anti-spoof-check" : false, + "vf-mirrors" : "SqknCX", + "vf-broadcast-allow" : true, + "vf-unknown-multicast-allow" : false, + "vf-unknown-unicast-allow" : false, + "vf-insert-stag" : true, + "vf-link-status" : "MsSX9hug4u1", + "neutron-network-id" : "f4jq6yFxVVtC" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "nested-linterface1", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + },{ + "interface-name" : "nested-linterface2", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + } ] + }, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "fc25fa49-ec46-43f5-bd39-c1c9067d2962-vk250x", + "l3-interface-ipv4-prefix-length" : 339, + "vlan-id-inner" : 644, + "vlan-id-outer" : 701, + "is-floating" : true, + "neutron-network-id" : "IEpYVl", + "neutron-subnet-id" : "7uWdipdgtC4Qc" + }, { + "l3-interface-ipv4-address" : "402d29fe-baf4-47e3-9208-e12a75e25349-vk250x", + "l3-interface-ipv4-prefix-length" : 370, + "vlan-id-inner" : 971, + "vlan-id-outer" : 142, + "is-floating" : false, + "neutron-network-id" : "sRi62ZY3IrKkq", + "neutron-subnet-id" : "PeV5RhIfV2Ib7" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "c9befce1-5617-4525-b217-105a57f6bd59-vk250x", + "l3-interface-ipv6-prefix-length" : 333, + "vlan-id-inner" : 275, + "vlan-id-outer" : 324, + "is-floating" : true, + "neutron-network-id" : "em6Lc6ovvWsdx", + "neutron-subnet-id" : "pyx4f" + }, { + "l3-interface-ipv6-address" : "18aa594c-143b-4564-ac0c-72144aecbb66-vk250x", + "l3-interface-ipv6-prefix-length" : 350, + "vlan-id-inner" : 893, + "vlan-id-outer" : 37, + "is-floating" : false, + "neutron-network-id" : "lhiR1", + "neutron-subnet-id" : "kdfoiCb7JYBuh" + } ] + } ] + } + } ] + } + } ] + }, + "flavors" : { + "flavor" : [ { + "flavor-id" : "a7208e23-b517-4ccb-a3ab-00952aa89480-vk250x", + "flavor-name" : "JGWnOD", + "flavor-vcpus" : 803, + "flavor-ram" : 920, + "flavor-disk" : 438, + "flavor-ephemeral" : 41, + "flavor-swap" : "KiuHc7", + "flavor-is-public" : false, + "flavor-selflink" : "pXtX", + "flavor-disabled" : false + } ] + }, + "group-assignments" : { + "group-assignment" : [ { + "group-id" : "30c1bb60-1b71-4b46-910f-d33c7905a779-vk250x", + "group-type" : "bRh", + "group-name" : "hg11sdvW", + "group-description" : "df3w60RR" + } ] + }, + "snapshots" : { + "snapshot" : [ { + "snapshot-id" : "26c013f4-c119-4ddd-89cf-e9b2729f87e5-vk250x", + "snapshot-name" : "0J3q8ZjyPGH", + "snapshot-architecture" : "wMu9Tvile", + "snapshot-os-distro" : "2Vv4Pqzu", + "snapshot-os-version" : "Vim0fyf404YVW", + "application" : "oxkCtHUk", + "application-vendor" : "tTpXkD", + "application-version" : "aOqn", + "snapshot-selflink" : "GCapKV9Tq", + "prev-snapshot-id" : "Imnj21xW5Hez" + }, { + "snapshot-id" : "ee2e8769-2dcf-4a3c-90bd-a0ba91c97f13-vk250x", + "snapshot-name" : "zRh94rw3pc1", + "snapshot-architecture" : "FxVDY", + "snapshot-os-distro" : "QZnKXjI5LDBSi", + "snapshot-os-version" : "u0Bl2moOJ7bb", + "application" : "dlXZPm9B7", + "application-vendor" : "89tls6", + "application-version" : "c05X", + "snapshot-selflink" : "rmExWmnDIZu3", + "prev-snapshot-id" : "5chZxlmHfhe" + } ] + }, + "images" : { + "image" : [ { + "image-id" : "691210f6-f3f2-488f-993c-a9c9570fb71f-vk250x", + "image-name" : "GsPzYlduuWk", + "image-architecture" : "vNdK4fYJf", + "image-os-distro" : "ZxYe", + "image-os-version" : "SVBBpHEc", + "application" : "GgBxi1zv8h2KG", + "application-vendor" : "x6NtDNUj", + "application-version" : "VOZYqE04K9", + "image-selflink" : "gOzbbHZtkuh", + "metadata" : { + "metadatum" : [ { + "metaname" : "b9565dfa-ed1f-4d35-90c6-bb56a48d9b2a-vk250x", + "metaval" : "nyq5IHmI" + } ] + } + }, { + "image-id" : "1f00c00a-9ab7-44a0-9961-bcf5f806fef8-vk250x", + "image-name" : "WChNCg3ThQ1Of", + "image-architecture" : "oL2m4nUPPG6j", + "image-os-distro" : "kf7", + "image-os-version" : "DxTTyv4S16e", + "application" : "Y0dytCJ2ouDk", + "application-vendor" : "F7E7a", + "application-version" : "8wkd3Cy", + "image-selflink" : "5N5A", + "metadata" : { + "metadatum" : [ { + "metaname" : "a5c4c98f-0b36-4f70-a235-5135e8e644f1-vk250x", + "metaval" : "vupk3k29rdN" + }, { + "metaname" : "e6084e48-df73-4854-a2be-522087b5f6a3-vk250x", + "metaval" : "l9VaEeP" + } ] + } + } ] + }, + "dvs-switches" : { + "dvs-switch" : [ { + "switch-name" : "b01222d9-f9f9-493d-8ee0-9ab7c095d5a0-vk250x", + "vcenter-url" : "NNtc" + }, { + "switch-name" : "7abed153-9fb5-4c05-87aa-ead0feb35b16-vk250x", + "vcenter-url" : "YSS" + } ] + }, + "oam-networks" : { + "oam-network" : [ { + "network-uuid" : "af2371f8-0fa6-4d4d-90c8-9c5d3ba3e01e-vk250x", + "network-name" : "cVevT9o20HAs4", + "cvlan-tag" : 560, + "ipv4-oam-gateway-address" : "F565rGb", + "ipv4-oam-gateway-address-prefix-length" : 540 + } ] + }, + "availability-zones" : { + "availability-zone" : [ { + "availability-zone-name" : "9761e922-fd2a-4c96-9a13-4e62e1daccdc-vk250x", + "hypervisor-type" : "qijdeI", + "operational-status" : "C0KkUiJ" + } ] + }, + "vip-ipv4-address-list" : [ { + "vip-ipv4-address" : "08b4a6c1-c702-4449-8791-caaa5341c6d9-vk250x", + "vip-ipv4-prefix-length" : 185, + "vlan-id-inner" : 969, + "vlan-id-outer" : 414, + "is-floating" : true, + "neutron-network-id" : "S7r90cEZ", + "neutron-subnet-id" : "2NwjH" + } ], + "vip-ipv6-address-list" : [ { + "vip-ipv6-address" : "f01dbad0-10c5-491c-a6e5-d972c9b99f56-vk250x", + "vip-ipv6-prefix-length" : 365, + "vlan-id-inner" : 326, + "vlan-id-outer" : 927, + "is-floating" : true, + "neutron-network-id" : "ULEl0", + "neutron-subnet-id" : "eyt9" + } ] +} \ No newline at end of file diff --git a/aai-core/src/test/resources/payloads/templates/generic-vnf-with-lag-interface.json b/aai-core/src/test/resources/payloads/templates/generic-vnf-with-lag-interface.json new file mode 100644 index 00000000..fc025bb2 --- /dev/null +++ b/aai-core/src/test/resources/payloads/templates/generic-vnf-with-lag-interface.json @@ -0,0 +1,24 @@ +{ + "vnf-id": "vnf1", + "vnf-type": "someval", + "vnf-name": "someval", + "lag-interfaces": { + "lag-interface": [ + { + "interface-name": "lag1", + "l-interfaces": { + "l-interface": [ + { + "interface-name": "int1", + "l3-interface-ipv6-address-list": [ + { + "l3-interface-ipv6-address": "${ip-address}" + } + ] + } + ] + } + } + ] + } +} diff --git a/aai-core/src/test/resources/payloads/templates/tenant.json b/aai-core/src/test/resources/payloads/templates/tenant.json new file mode 100644 index 00000000..ce0f5588 --- /dev/null +++ b/aai-core/src/test/resources/payloads/templates/tenant.json @@ -0,0 +1,169 @@ +{ + "tenant-id" : "${tenant-id}", + "tenant-name" : "yhgVBcv3Pr", + "tenant-context" : "De4NNayqFBO", + "vservers" : { + "vserver" : [ { + "vserver-id" : "${vserver-id}", + "vserver-name" : "P3SJ347Uyv", + "vserver-name2" : "1dHd", + "prov-status" : "PR04shorWQ", + "vserver-selflink" : "v7dU8H", + "in-maint" : false, + "is-closed-loop-disabled" : true, + "volumes" : { + "volume" : [ { + "volume-id" : "61cbb17e-8e5f-4545-a8ea-13a0e9c9871f-vk250x", + "volume-selflink" : "mYkfJ9rGv" + }, { + "volume-id" : "d98083a6-b235-4e54-b19b-2ebfa1604246-vk250x", + "volume-selflink" : "69RRsreL4" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "top-linterface", + "interface-role" : "3W1FAJGSQ", + "v6-wan-link-ip" : "WugWw3N", + "selflink" : "Of4j0pU", + "interface-id" : "eoW", + "macaddr" : "XNbbIy33", + "network-name" : "ZETDv5sGhiS", + "management-option" : "qR3RyCxgEU", + "interface-description" : "ksuRPpWDEH7", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "20Q0ZE6n5iB0", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "KjPXyH", + "vlans" : { + "vlan" : [ { + "vlan-interface" : "8d225c33-7494-4173-939f-0e1e8741344d-vk250x", + "vlan-id-inner" : 884, + "vlan-id-outer" : 992, + "speed-value" : "RyFPm", + "speed-units" : "ZrckmLff7b", + "vlan-description" : "zjAeUFgeagpf", + "backdoor-connection" : "gANMvUquB", + "vpn-key" : "l0rV7bb2Sc", + "orchestration-status" : "WVnLpbzIx", + "in-maint" : false, + "prov-status" : "tYMRi6df", + "is-ip-unnumbered" : false, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "2e7d62a5-ff93-446f-9fa3-b4ba585e742b-vk250x", + "l3-interface-ipv4-prefix-length" : 640, + "vlan-id-inner" : 652, + "vlan-id-outer" : 868, + "is-floating" : true, + "neutron-network-id" : "dJ8Fqs4ZTRn", + "neutron-subnet-id" : "HC6ji9DO8" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "818cd2e5-8dac-4a49-aa2e-4f97d4e98594-vk250x", + "l3-interface-ipv6-prefix-length" : 910, + "vlan-id-inner" : 116, + "vlan-id-outer" : 661, + "is-floating" : true, + "neutron-network-id" : "vSpYqFg5Tfe", + "neutron-subnet-id" : "bqkOUZSlVF" + }, { + "l3-interface-ipv6-address" : "915a8e5d-9d39-4f99-a350-c48f48ac8f46-vk250x", + "l3-interface-ipv6-prefix-length" : 593, + "vlan-id-inner" : 554, + "vlan-id-outer" : 762, + "is-floating" : false, + "neutron-network-id" : "b7PM", + "neutron-subnet-id" : "u51Ma93" + } ] + } ] + }, + "sriov-vfs" : { + "sriov-vf" : [ { + "pci-id" : "01ca7dbe-e270-4545-a045-72e9e3fcb44b-vk250x", + "vf-vlan-filter" : "f9YNFlqrfHi", + "vf-mac-filter" : "HQhFdXpL1v", + "vf-vlan-strip" : true, + "vf-vlan-anti-spoof-check" : false, + "vf-mac-anti-spoof-check" : false, + "vf-mirrors" : "SqknCX", + "vf-broadcast-allow" : true, + "vf-unknown-multicast-allow" : false, + "vf-unknown-unicast-allow" : false, + "vf-insert-stag" : true, + "vf-link-status" : "MsSX9hug4u1", + "neutron-network-id" : "f4jq6yFxVVtC" + } ] + }, + "l-interfaces" : { + "l-interface" : [ { + "interface-name" : "nested-linterface1", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + },{ + "interface-name" : "nested-linterface2", + "interface-role" : "ZjOYJKIE4j9W1", + "v6-wan-link-ip" : "63RKRTd", + "selflink" : "5xF", + "interface-id" : "akNmnDyijrHla", + "macaddr" : "XLZCof4", + "network-name" : "yJt", + "management-option" : "FJ6qVt", + "interface-description" : "fCHE1Glz", + "is-port-mirrored" : false, + "in-maint" : false, + "prov-status" : "vuTb", + "is-ip-unnumbered" : false, + "allowed-address-pairs" : "5Lzn9" + } ] + }, + "l3-interface-ipv4-address-list" : [ { + "l3-interface-ipv4-address" : "fc25fa49-ec46-43f5-bd39-c1c9067d2962-vk250x", + "l3-interface-ipv4-prefix-length" : 339, + "vlan-id-inner" : 644, + "vlan-id-outer" : 701, + "is-floating" : true, + "neutron-network-id" : "IEpYVl", + "neutron-subnet-id" : "7uWdipdgtC4Qc" + }, { + "l3-interface-ipv4-address" : "402d29fe-baf4-47e3-9208-e12a75e25349-vk250x", + "l3-interface-ipv4-prefix-length" : 370, + "vlan-id-inner" : 971, + "vlan-id-outer" : 142, + "is-floating" : false, + "neutron-network-id" : "sRi62ZY3IrKkq", + "neutron-subnet-id" : "PeV5RhIfV2Ib7" + } ], + "l3-interface-ipv6-address-list" : [ { + "l3-interface-ipv6-address" : "c9befce1-5617-4525-b217-105a57f6bd59-vk250x", + "l3-interface-ipv6-prefix-length" : 333, + "vlan-id-inner" : 275, + "vlan-id-outer" : 324, + "is-floating" : true, + "neutron-network-id" : "em6Lc6ovvWsdx", + "neutron-subnet-id" : "pyx4f" + }, { + "l3-interface-ipv6-address" : "18aa594c-143b-4564-ac0c-72144aecbb66-vk250x", + "l3-interface-ipv6-prefix-length" : 350, + "vlan-id-inner" : 893, + "vlan-id-outer" : 37, + "is-floating" : false, + "neutron-network-id" : "lhiR1", + "neutron-subnet-id" : "kdfoiCb7JYBuh" + } ] + } ] + } + } ] + } +} \ No newline at end of file diff --git a/aai-schema/.classpath b/aai-schema/.classpath index 6ff0f58b..8c0f651e 100644 --- a/aai-schema/.classpath +++ b/aai-schema/.classpath @@ -12,12 +12,12 @@ - + - + diff --git a/aai-schema/src/main/resources/aai_schema/aai_schema_v12.xsd b/aai-schema/src/main/resources/aai_schema/aai_schema_v12.xsd index 69cd382a..b3a2c7d9 100644 --- a/aai-schema/src/main/resources/aai_schema/aai_schema_v12.xsd +++ b/aai-schema/src/main/resources/aai_schema/aai_schema_v12.xsd @@ -1866,14 +1866,14 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - @org.onap.aai.annotations.Metadata(description="cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.",indexedProps="cloud-owner,cloud-region-id,cloud-type,owner-defined-type",nameProps="owner-defined-type",container="cloud-regions",namespace="cloud-infrastructure") + @org.onap.aai.annotations.Metadata(description="cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname",indexedProps="cloud-owner,cloud-region-id,cloud-type,owner-defined-type",nameProps="owner-defined-type",container="cloud-regions",namespace="cloud-infrastructure") - @org.onap.aai.annotations.Metadata(isKey=true,description="Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname") + @org.onap.aai.annotations.Metadata(isKey=true,description="Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname") @@ -2263,13 +2263,6 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - - - - @org.onap.aai.annotations.Metadata(description="URL to endpoint where AAI can get more details.") - - - @@ -3017,28 +3010,28 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - + @org.onap.aai.annotations.Metadata(description="The WAN uplink bandwidth for WAN1") - + @org.onap.aai.annotations.Metadata(description="The WAN downlink bandwidth for WAN1") - + @org.onap.aai.annotations.Metadata(description="The WAN uplink bandwidth for WAN2") - + @org.onap.aai.annotations.Metadata(description="The WAN downlink bandwidth for WAN2") @@ -4273,7 +4266,7 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - @org.onap.aai.annotations.Metadata(description="v4, v6, or ds for dual stack (should be att-ip-version)") + @org.onap.aai.annotations.Metadata(description="v4, v6, or ds for dual stack") @@ -7271,11 +7264,196 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + + @org.onap.aai.annotations.Metadata(description="forwarder object is an optional child object of the Configuration object.",dependentOn="configuration",uniqueProps="forwarder-evc-id",container="forwarder-evcs") + + + + + + + @org.onap.aai.annotations.Metadata(isKey=true,description="Key for forwarder-evc object") + + + + + + + @org.onap.aai.annotations.Metadata(description="Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC") + + + + + + + @org.onap.aai.annotations.Metadata(description="Internal VLAN.") + + + + + + + @org.onap.aai.annotations.Metadata(description="SVLAN value for ingress of egress forwarder.") + + + + + + + @org.onap.aai.annotations.Metadata(description="CVLAN value for ingress of egress forwarder.") + + + + + + + + @org.onap.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + + + + + + + @org.onap.aai.annotations.Metadata(description="evc object is an optional child object of the Configuration object.",dependentOn="configuration",uniqueProps="evc-id",container="evcs") + + + + + + + @org.onap.aai.annotations.Metadata(isKey=true,description="Unique/key field for the evc object") + + + + + + + @org.onap.aai.annotations.Metadata(description="Point-to-Point, Multi-Point") + + + + + + + @org.onap.aai.annotations.Metadata(description="Commited Information Rate") + + + + + + + @org.onap.aai.annotations.Metadata(description="CIR units") + + + + + + + @org.onap.aai.annotations.Metadata(description="Diversity Group ID") + + + + + + + @org.onap.aai.annotations.Metadata(description="formerly Performance Group") + + + + + + + @org.onap.aai.annotations.Metadata(description="EVC Circuit ID of ESP EVC") + + + + + + + @org.onap.aai.annotations.Metadata(description="Committed Information Rate (For ESP)") + + + + + + + @org.onap.aai.annotations.Metadata(description="CIR units (For ESP)") + + + + + + + @org.onap.aai.annotations.Metadata(description="Identifies ESP") + + + + + + + @org.onap.aai.annotations.Metadata(description="Collector POP CLLI (from the hostname of the access pnf)") + + + + + + + @org.onap.aai.annotations.Metadata(description="Interconnect type on ingress side of EVC.") + + + + + + + @org.onap.aai.annotations.Metadata(description="tagode for collector side of EVC") + + + + + + + @org.onap.aai.annotations.Metadata(description="tagMode for network side of EVC") + + + + + + + + @org.onap.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + + - @org.onap.aai.annotations.Metadata(description="Port Mirror Configuration.",indexedProps="configuration-id,model-invariant-id,model-version-id",uniqueProps="configuration-id",container="configurations",namespace="network",nameProps="configuration-type") + @org.onap.aai.annotations.Metadata(description="Generic configuration object.",indexedProps="configuration-id,model-invariant-id,model-version-id",uniqueProps="configuration-id",container="configurations",namespace="network") @@ -7328,28 +7506,28 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - + @org.onap.aai.annotations.Metadata(description="Orchestration status of the configuration.") - + @org.onap.aai.annotations.Metadata(description="Indicator for whether the resource is considered operational.") - + @org.onap.aai.annotations.Metadata(description="URL to endpoint where AAI can get more details from SDN-GC.") - + @org.onap.aai.annotations.Metadata(description="id of the configuration used to customize the resource") @@ -7379,6 +7557,8 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + @@ -7409,6 +7589,13 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + @org.onap.aai.annotations.Metadata(description="ingress, intermediate, egress") + + + @@ -7528,7 +7715,7 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - @org.onap.aai.annotations.Metadata(description="Internal map to define the properties of an edge and interpret the map EdgeRules",edgeInfo="edgeLabel,direction,multiplicityRule,isParent,usesResource,hasDelTarget,SVC-INFRA,SVC-INFRA-REV") + @org.onap.aai.annotations.Metadata(description="Internal map to define the properties of an edge and interpret the map EdgeRules",edgeInfo="aaiUuid,edgeLabel,direction,multiplicityRule,isParent,usesResource,hasDelTarget,SVC-INFRA,SVC-INFRA-REV",uniqueProps="aai-uuid",indexedProps="aai-uuid") @@ -7539,6 +7726,7 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html new file mode 100644 index 00000000..d16b210a --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html @@ -0,0 +1,189965 @@ + + + + + + + Active and Available Inventory REST API. + + +
+

Active and Available Inventory REST API.

+

Version: v12

+


+[Differences versus the previous schema version](apidocs/aai_swagger_v12.diff)
+
+Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
+
+You may obtain a copy of the License at
+
+(https://creativecommons.org/licenses/by/4.0/)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
+
+This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.

+

+ +
+ Schemes: + https +
+ + +

Summary

+ +

Tag: CloudInfrastructure

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /cloud-infrastructure/cloud-regions

returns cloud-regions

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

returns cloud-region

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

create or update an existing cloud-region

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

update an existing cloud-region

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

delete an existing cloud-region

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones

returns availability-zones

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

returns availability-zone

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

create or update an existing availability-zone

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

update an existing availability-zone

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

delete an existing availability-zone

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches

returns dvs-switches

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

returns dvs-switch

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

create or update an existing dvs-switch

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

update an existing dvs-switch

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

delete an existing dvs-switch

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors

returns flavors

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

returns flavor

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

create or update an existing flavor

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

update an existing flavor

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

delete an existing flavor

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

see node definition for valid relationships

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

delete an existing relationship

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

returns group-assignments

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

returns group-assignment

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

create or update an existing group-assignment

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

update 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 group-assignment

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

see node definition for valid relationships

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

delete an existing relationship

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

returns images

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

returns image

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

create or update an existing image

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

update an existing image

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

delete an existing image

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

returns metadata

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

returns metadatum

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

create or update an existing metadatum

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

update an existing metadatum

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

delete an existing metadatum

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

returns oam-networks

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

returns oam-network

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

create or update an existing oam-network

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

update an existing oam-network

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

delete an existing oam-network

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

delete an existing relationship

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

returns snapshots

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

returns snapshot

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

create or update an existing snapshot

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

update an existing snapshot

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

delete an existing snapshot

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

delete an existing relationship

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

returns tenants

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

returns tenant

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

create or update an existing tenant

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

update an existing tenant

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

delete an existing tenant

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

delete an existing relationship

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

returns vservers

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

returns vserver

+
PUT /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

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

update an existing vserver

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

delete an existing vserver

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

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/l-interface/{interface-name}

returns 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}

create or 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}

update 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}

delete an existing 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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

see node definition for valid relationships

+
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

delete an existing relationship

+
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

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/sriov-vf/{pci-id}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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

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/vlan/{vlan-interface}

returns 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 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 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 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
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

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /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

+
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 relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

returns volumes

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

returns 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-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-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-ipv4-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

returns vip-ipv6-address-list

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

returns volume-groups

+
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

returns 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 volume-group

+
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

update 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 volume-group

+
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/complexes

returns complexes

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}

returns complex

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

create or update an existing complex

+
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

update an existing complex

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

delete an existing complex

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

returns ctag-pools

+
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

returns ctag-pool

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

create or 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 ctag-pool

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

delete an existing ctag-pool

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/network-profiles

returns network-profiles

+
GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

returns network-profile

+
PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

create or update an existing network-profile

+
PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

update an existing network-profile

+
DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

delete an existing network-profile

+
PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/operational-environments

returns operational-environments

+
GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

returns operational-environment

+
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

create or update an existing operational-environment

+
PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

update an existing operational-environment

+
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

delete an existing operational-environment

+
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers

returns pservers

+
GET /cloud-infrastructure/pservers/pserver/{hostname}

returns pserver

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}

create or update an existing pserver

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}

update an existing pserver

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}

delete an existing pserver

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

returns lag-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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-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-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-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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns 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 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 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 vlan

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
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

see node definition for valid relationships

+
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 an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

returns p-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns 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 l-interface

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update 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 l-interface

+
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}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
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}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /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 vlan

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update 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}

delete an existing vlan

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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 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-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-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-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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing 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

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

delete an existing relationship

+
GET /cloud-infrastructure/virtual-data-centers

returns virtual-data-centers

+
GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

returns virtual-data-center

+
PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

create or update an existing virtual-data-center

+
PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

update an existing virtual-data-center

+
DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

delete an existing virtual-data-center

+
PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: Business

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /business/connectors

returns connectors

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

returns connector

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

create or update an existing connector

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

update an existing connector

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

delete an existing connector

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

returns metadata

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

returns metadatum

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

create or update an existing metadatum

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

update an existing metadatum

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

delete an existing metadatum

+
PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers

returns customers

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

returns customer

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

create or update an existing customer

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

update an existing customer

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

delete an existing customer

+
PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/customers/customer/{global-customer-id}/service-subscriptions

returns service-subscriptions

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

returns service-subscription

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

create or update an existing service-subscription

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

update an existing service-subscription

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

delete an existing service-subscription

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

delete an existing relationship

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

returns service-instances

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

returns service-instance

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

create or update an existing service-instance

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

update an existing service-instance

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

delete an existing service-instance

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

returns allotted-resources

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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

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/tunnel-xconnect/{id}

returns tunnel-xconnect

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

create or update an existing tunnel-xconnect

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

update an existing tunnel-xconnect

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

delete an existing tunnel-xconnect

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

see node definition for valid relationships

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

delete an existing relationship

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

returns metadata

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

returns metadatum

+
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

delete an existing metadatum

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /business/lines-of-business

returns lines-of-business

+
GET /business/lines-of-business/line-of-business/{line-of-business-name}

returns line-of-business

+
PUT /business/lines-of-business/line-of-business/{line-of-business-name}

create or update an existing line-of-business

+
PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

update an existing line-of-business

+
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

delete an existing line-of-business

+
PUT /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

delete an existing relationship

+
GET /business/owning-entities

returns owning-entities

+
GET /business/owning-entities/owning-entity/{owning-entity-id}

returns owning-entity

+
PUT /business/owning-entities/owning-entity/{owning-entity-id}

create or update an existing owning-entity

+
PATCH /business/owning-entities/owning-entity/{owning-entity-id}

update an existing owning-entity

+
DELETE /business/owning-entities/owning-entity/{owning-entity-id}

delete an existing owning-entity

+
PUT /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/platforms

returns platforms

+
GET /business/platforms/platform/{platform-name}

returns platform

+
PUT /business/platforms/platform/{platform-name}

create or update an existing platform

+
PATCH /business/platforms/platform/{platform-name}

update an existing platform

+
DELETE /business/platforms/platform/{platform-name}

delete an existing platform

+
PUT /business/platforms/platform/{platform-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

delete an existing relationship

+
GET /business/projects

returns projects

+
GET /business/projects/project/{project-name}

returns project

+
PUT /business/projects/project/{project-name}

create or update an existing project

+
PATCH /business/projects/project/{project-name}

update an existing project

+
DELETE /business/projects/project/{project-name}

delete an existing project

+
PUT /business/projects/project/{project-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /business/projects/project/{project-name}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: ServiceDesignAndCreation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /service-design-and-creation/models

returns models

+
GET /service-design-and-creation/models/model/{model-invariant-id}

returns model

+
PUT /service-design-and-creation/models/model/{model-invariant-id}

create or update an existing model

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}

update an existing model

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}

delete an existing model

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

returns model-vers

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

returns model-ver

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

create or update an existing model-ver

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

update an existing model-ver

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

delete an existing model-ver

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

returns metadata

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

returns model-elements

+
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

returns model-element

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

create or update an existing model-element

+
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

update an existing model-element

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

delete an existing model-element

+
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

returns model-constraints

+
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}

returns 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}

create or 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}

update 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}

delete an existing model-constraint

+
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-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}

returns 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}

create or 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}

update 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}

delete an existing 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}/element-choice-sets

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/element-choice-set/{element-choice-set-uuid}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing 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

see node definition for valid relationships

+
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 an existing 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

see node definition for valid relationships

+
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 an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/named-queries

returns named-queries

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

returns named-query

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

create or update an existing named-query

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

update an existing named-query

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

delete an existing named-query

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

returns named-query-elements

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

returns named-query-element

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

create or update an existing named-query-element

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

update an existing named-query-element

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

delete an existing named-query-element

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

returns property-constraints

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

returns property-constraint

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

create or update an existing property-constraint

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

update an existing property-constraint

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

delete an existing property-constraint

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

returns related-lookups

+
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

returns related-lookup

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

create or update an existing related-lookup

+
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

update an existing related-lookup

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

delete an existing related-lookup

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/service-capabilities

returns service-capabilities

+
GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

returns service-capability

+
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

create or update an existing service-capability

+
PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

update an existing service-capability

+
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

delete an existing service-capability

+
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/services

returns services

+
GET /service-design-and-creation/services/service/{service-id}

returns service

+
PUT /service-design-and-creation/services/service/{service-id}

create or update an existing service

+
PATCH /service-design-and-creation/services/service/{service-id}

update an existing service

+
DELETE /service-design-and-creation/services/service/{service-id}

delete an existing service

+
PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

delete an existing relationship

+
GET /service-design-and-creation/vnf-images

returns vnf-images

+
GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

returns vnf-image

+
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

create or update an existing vnf-image

+
PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

update an existing vnf-image

+
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

delete an existing vnf-image

+
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

delete an existing relationship

+
+ + +

Tag: Network

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperationDescription
GET /network/configurations

returns configurations

+
GET /network/configurations/configuration/{configuration-id}

returns configuration

+
PUT /network/configurations/configuration/{configuration-id}

create or update an existing configuration

+
PATCH /network/configurations/configuration/{configuration-id}

update an existing configuration

+
DELETE /network/configurations/configuration/{configuration-id}

delete an existing configuration

+
GET /network/configurations/configuration/{configuration-id}/evcs

returns evcs

+
GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

returns evc

+
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

create or update an existing evc

+
PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

update an existing evc

+
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

delete an existing evc

+
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

returns forwarder-evcs

+
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

returns forwarder-evc

+
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

create or update an existing forwarder-evc

+
PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

update an existing forwarder-evc

+
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

delete an existing forwarder-evc

+
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/configurations/configuration/{configuration-id}/metadata

returns metadata

+
GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

returns metadatum

+
PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

+
PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

update an existing metadatum

+
DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

delete an existing metadatum

+
PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/forwarding-paths

returns forwarding-paths

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

returns forwarding-path

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

create or update an existing forwarding-path

+
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

update an existing forwarding-path

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

delete an existing forwarding-path

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

returns forwarders

+
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

returns forwarder

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

create or update an existing forwarder

+
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

update an existing forwarder

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

delete an existing forwarder

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

delete an existing relationship

+
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs

returns generic-vnfs

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}

returns generic-vnf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}

create or update an existing generic-vnf

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

update an existing generic-vnf

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

delete an existing generic-vnf

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

returns entitlements

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

returns l-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or 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}

update an existing sriov-vf

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

returns lag-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or 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}

update an existing l-interface

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

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/sriov-vf/{pci-id}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns 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}

create or 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}

update 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}

delete an existing 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

returns licenses

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

returns vf-modules

+
GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

returns vf-module

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

create or update an existing vf-module

+
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

update an existing vf-module

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

delete an existing vf-module

+
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/instance-groups

returns instance-groups

+
GET /network/instance-groups/instance-group/{id}

returns instance-group

+
PUT /network/instance-groups/instance-group/{id}

create or update an existing instance-group

+
PATCH /network/instance-groups/instance-group/{id}

update an existing instance-group

+
DELETE /network/instance-groups/instance-group/{id}

delete an existing instance-group

+
PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

delete an existing relationship

+
GET /network/ipsec-configurations

returns ipsec-configurations

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

returns ipsec-configuration

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

create or update an existing ipsec-configuration

+
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

update an existing ipsec-configuration

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

delete an existing ipsec-configuration

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

returns vig-servers

+
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

returns vig-server

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

create or update an existing vig-server

+
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

update an existing vig-server

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

delete an existing vig-server

+
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks

returns l3-networks

+
GET /network/l3-networks/l3-network/{network-id}

returns l3-network

+
PUT /network/l3-networks/l3-network/{network-id}

create or update an existing l3-network

+
PATCH /network/l3-networks/l3-network/{network-id}

update an existing l3-network

+
DELETE /network/l3-networks/l3-network/{network-id}

delete an existing l3-network

+
GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

returns ctag-assignments

+
GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

returns ctag-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

create or update an existing ctag-assignment

+
PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

update an existing ctag-assignment

+
DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

delete an existing ctag-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

delete an existing relationship

+
PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

returns segmentation-assignments

+
GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

returns segmentation-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

create or update an existing segmentation-assignment

+
PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

update an existing segmentation-assignment

+
DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

delete an existing segmentation-assignment

+
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/l3-networks/l3-network/{network-id}/subnets

returns subnets

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

returns subnet

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

create or update an existing subnet

+
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

update an existing subnet

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

delete an existing subnet

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

returns host-routes

+
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

returns host-route

+
PUT /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

+
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

update 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 host-route

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/lag-links

returns lag-links

+
GET /network/lag-links/lag-link/{link-name}

returns lag-link

+
PUT /network/lag-links/lag-link/{link-name}

create or update an existing lag-link

+
PATCH /network/lag-links/lag-link/{link-name}

update an existing lag-link

+
DELETE /network/lag-links/lag-link/{link-name}

delete an existing lag-link

+
PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/logical-links

returns logical-links

+
GET /network/logical-links/logical-link/{link-name}

returns logical-link

+
PUT /network/logical-links/logical-link/{link-name}

create or update an existing logical-link

+
PATCH /network/logical-links/logical-link/{link-name}

update an existing logical-link

+
DELETE /network/logical-links/logical-link/{link-name}

delete an existing logical-link

+
PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/multicast-configurations

returns multicast-configurations

+
GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

returns multicast-configuration

+
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

create or update an existing multicast-configuration

+
PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

update an existing multicast-configuration

+
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

delete an existing multicast-configuration

+
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/network-policies

returns network-policies

+
GET /network/network-policies/network-policy/{network-policy-id}

returns network-policy

+
PUT /network/network-policies/network-policy/{network-policy-id}

create or update an existing network-policy

+
PATCH /network/network-policies/network-policy/{network-policy-id}

update an existing network-policy

+
DELETE /network/network-policies/network-policy/{network-policy-id}

delete an existing network-policy

+
PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces

returns newvces

+
GET /network/newvces/newvce/{vnf-id2}

returns newvce

+
PUT /network/newvces/newvce/{vnf-id2}

create or update an existing newvce

+
PATCH /network/newvces/newvce/{vnf-id2}

update an existing newvce

+
DELETE /network/newvces/newvce/{vnf-id2}

delete an existing newvce

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces

returns l-interfaces

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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 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 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update 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 sriov-vf

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
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}

returns 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

delete an existing relationship

+
GET /network/physical-links

returns physical-links

+
GET /network/physical-links/physical-link/{link-name}

returns physical-link

+
PUT /network/physical-links/physical-link/{link-name}

create or update an existing physical-link

+
PATCH /network/physical-links/physical-link/{link-name}

update an existing physical-link

+
DELETE /network/physical-links/physical-link/{link-name}

delete an existing physical-link

+
PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs

returns pnfs

+
GET /network/pnfs/pnf/{pnf-name}

returns pnf

+
PUT /network/pnfs/pnf/{pnf-name}

create or update an existing pnf

+
PATCH /network/pnfs/pnf/{pnf-name}

update an existing pnf

+
DELETE /network/pnfs/pnf/{pnf-name}

delete an existing pnf

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

returns lag-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or 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 l-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
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 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /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

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns 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 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 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 vlan

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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}

returns l3-interface-ipv6-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-ipv6-address-list/{l3-interface-ipv6-address}

create or 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces

returns p-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
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}

create or 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}

update 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}

delete 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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}

returns l3-interface-ipv6-address-list

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /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

+
PATCH /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

+
DELETE /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

+
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}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing 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

see node definition for valid relationships

+
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 an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/route-table-references

returns route-table-references

+
GET /network/route-table-references/route-table-reference/{route-table-reference-id}

returns route-table-reference

+
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

create or update an existing route-table-reference

+
PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

update an existing route-table-reference

+
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

delete an existing route-table-reference

+
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets

returns site-pair-sets

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

returns site-pair-set

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

create or update an existing site-pair-set

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

update an existing site-pair-set

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

delete an existing site-pair-set

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

returns routing-instances

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

returns routing-instance

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

create or update an existing routing-instance

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

update an existing routing-instance

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

delete an existing routing-instance

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

returns site-pairs

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

returns site-pair

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

create or update an existing site-pair

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

update an existing site-pair

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

delete an existing site-pair

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

returns classes-of-service

+
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

returns class-of-service

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

create or update an existing class-of-service

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

update an existing class-of-service

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

delete an existing class-of-service

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

delete an existing relationship

+
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces

returns vces

+
GET /network/vces/vce/{vnf-id}

returns vce

+
PUT /network/vces/vce/{vnf-id}

create or update an existing vce

+
PATCH /network/vces/vce/{vnf-id}

update an existing vce

+
DELETE /network/vces/vce/{vnf-id}

delete an existing vce

+
GET /network/vces/vce/{vnf-id}/entitlements

returns entitlements

+
GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

+
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

+
DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

+
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces/vce/{vnf-id}/licenses

returns licenses

+
GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

+
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

+
DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

+
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

+
GET /network/vces/vce/{vnf-id}/port-groups

returns port-groups

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

returns port-group

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

create or update an existing port-group

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

update an existing port-group

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

delete an existing port-group

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

returns cvlan-tags

+
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

returns cvlan-tag-entry

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

create or update an existing cvlan-tag-entry

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

update an existing cvlan-tag-entry

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

delete an existing cvlan-tag-entry

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vnfcs

returns vnfcs

+
GET /network/vnfcs/vnfc/{vnfc-name}

returns vnfc

+
PUT /network/vnfcs/vnfc/{vnfc-name}

create or update an existing vnfc

+
PATCH /network/vnfcs/vnfc/{vnfc-name}

update an existing vnfc

+
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc

+
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

+
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes

returns vpls-pes

+
GET /network/vpls-pes/vpls-pe/{equipment-name}

returns vpls-pe

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}

create or update an existing vpls-pe

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}

update an existing vpls-pe

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}

delete an existing vpls-pe

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

returns lag-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns 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 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 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 l-interface

+
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 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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 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 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 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
PUT /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

+
DELETE /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 relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

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/sriov-vf/{pci-id}

returns 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}

create or 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}

update 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 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}/relationship-list/relationship

see node definition for valid relationships

+
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 an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
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 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 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 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 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns 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}

create or 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}

update 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}

delete 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}/relationship-list/relationship

see node definition for valid relationships

+
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 relationship

+
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}

returns 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

returns p-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

returns p-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
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}

create or 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}

update 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}

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

+
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

see node definition for valid relationships

+
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 relationship

+
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}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

+
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

delete an existing relationship

+
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}

returns l3-interface-ipv6-address-list

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs

+
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

+
PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpn-bindings

returns vpn-bindings

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}

returns vpn-binding

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}

create or update an existing vpn-binding

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

update an existing vpn-binding

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

delete an existing vpn-binding

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

delete an existing relationship

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

returns route-targets

+
GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

returns route-target

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

create or update an existing route-target

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

update an existing route-target

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

delete an existing route-target

+
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

delete an existing relationship

+
GET /network/zones

returns zones

+
GET /network/zones/zone/{zone-id}

returns zone

+
PUT /network/zones/zone/{zone-id}

create or update an existing zone

+
PATCH /network/zones/zone/{zone-id}

update an existing zone

+
DELETE /network/zones/zone/{zone-id}

delete an existing zone

+
PUT /network/zones/zone/{zone-id}/relationship-list/relationship

see node definition for valid relationships

+
DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

delete an existing relationship

+
+ + + + +

Paths

+ + + +
+
+
returns connectors
+

GET /business/connectors

+ Tags: + Business +
+
+
+

returns connectors

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /connectors +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns connector
+

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

+ Tags: + Business +
+
+
+

returns connector

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		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 + 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

+ +
+
+
+ +
+
+ +
+ /connector +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing connector
+

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

+ Tags: + Business +
+
+
+

create or update an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /connector +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing connector
+

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

+ Tags: + Business +
+
+
+

update an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+

connector object that needs to be created or updated.

+

+
+
+
+
+ /connector +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing connector
+

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

+ Tags: + Business +
+
+
+

delete an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

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

+ Tags: + Business +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		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 + 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

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

Response codes found in response codes.

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

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

+ Tags: + Business +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		path + string + + + +
+ metaname + + 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 + 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

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Business +
+
+
+

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/v12/BusinessConnectorsConnectorMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

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

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

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

+ Tags: + Business +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

+ 		path + string + + + +
+ metaname + + 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 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessConnectorsConnector.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns customers
+

GET /business/customers

+ Tags: + Business +
+
+
+

returns customers

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /customers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns customer
+

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

+ Tags: + Business +
+
+
+

returns customer

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

Global customer id used across ECOMP to uniquely identify customer.

+ 		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

+ +
+
+
+ +
+
+ +
+ /customer +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing customer
+

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

+ Tags: + Business +
+
+
+

create or update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing customer
+

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

+ Tags: + Business +
+
+
+

update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

customer object that needs to be created or 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

+ +
+
+ +

application/json application/xml +

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

Global customer id used across ECOMP to uniquely identify customer.

+ 		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 /business/customers/customer/{global-customer-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessCustomersCustomer.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 relationship
+

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

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-subscriptions
+

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

+ Tags: + Business +
+
+
+

returns service-subscriptions

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

Global customer id used across ECOMP to uniquely identify customer.

+ 		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

+ +
+
+
+ +
+
+ +
+ /service-subscriptions +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-subscription
+

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

+ Tags: + Business +
+
+
+

returns service-subscription

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /service-subscription +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-subscription
+

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

create or update an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+

service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

+

+
+
+
+
+ /service-subscription +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-subscription
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

update an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /service-subscription +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-subscription
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

+ Tags: + Business +
+
+
+

delete an existing service-subscription

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-instances
+

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

+ Tags: + Business +
+
+
+

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

+ +
+
+
+ +
+
+ +
+ /service-instances +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /service-instance +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-instance
+

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

+ Tags: + Business +
+
+
+

create or update an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+

service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

+

+
+
+
+
+ /service-instance +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-instance
+

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

+ Tags: + Business +
+
+
+

update an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /service-instance +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-instance
+

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

+ Tags: + Business +
+
+
+

delete an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns allotted-resources
+

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

+ Tags: + Business +
+
+
+

returns allotted-resources

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /allotted-resources +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /allotted-resource +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

+

+
+
+
+
+ /allotted-resource +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /allotted-resource +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /tunnel-xconnects +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tunnel-xconnect
+

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

+ Tags: + Business +
+
+
+

returns tunnel-xconnect

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /tunnel-xconnect +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing tunnel-xconnect
+

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

+ Tags: + Business +
+
+
+

create or update an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+

tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

+

+
+
+
+
+ /tunnel-xconnect +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing tunnel-xconnect
+

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

+ Tags: + Business +
+
+
+

update an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /tunnel-xconnect +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing tunnel-xconnect
+

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

+ Tags: + Business +
+
+
+

delete an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

+ 		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 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ id + +

Allotted Resource id UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

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

+ Tags: + Business +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + Business +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ metaname + + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

+ Tags: + Business +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ metaname + + 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 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lines-of-business
+

GET /business/lines-of-business

+ Tags: + Business +
+
+
+

returns lines-of-business

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lines-of-business +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns line-of-business
+

GET /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

returns line-of-business

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /line-of-business +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing line-of-business
+

PUT /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

create or update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)

+

+
+
+
+
+ /line-of-business +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing line-of-business
+

PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /line-of-business +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing line-of-business
+

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

+ Tags: + Business +
+
+
+

delete an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

+ 		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 /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessLinesOfBusinessLineOfBusiness.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns owning-entities
+

GET /business/owning-entities

+ Tags: + Business +
+
+
+

returns owning-entities

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /owning-entities +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns owning-entity
+

GET /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

returns owning-entity

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /owning-entity +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing owning-entity
+

PUT /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

create or update an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+

owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)

+

+
+
+
+
+ /owning-entity +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing owning-entity
+

PATCH /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

update an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+

owning-entity object that needs to be created or updated.

+

+
+
+
+
+ /owning-entity +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing owning-entity
+

DELETE /business/owning-entities/owning-entity/{owning-entity-id}

+ Tags: + Business +
+
+
+

delete an existing owning-entity

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+ 		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 /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessOwningEntitiesOwningEntity.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns platforms
+

GET /business/platforms

+ Tags: + Business +
+
+
+

returns platforms

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /platforms +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns platform
+

GET /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

returns platform

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /platform +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing platform
+

PUT /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

create or update an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /platform +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing platform
+

PATCH /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

update an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+

platform object that needs to be created or updated.

+

+
+
+
+
+ /platform +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing platform
+

DELETE /business/platforms/platform/{platform-name}

+ Tags: + Business +
+
+
+

delete an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

+ 		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 /business/platforms/platform/{platform-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessPlatformsPlatform.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns projects
+

GET /business/projects

+ Tags: + Business +
+
+
+

returns projects

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /projects +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns project
+

GET /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

returns project

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /project +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing project
+

PUT /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

create or update an existing project

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /project +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing project
+

PATCH /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

update an existing project

+ +
+
+ +

application/json application/xml +

+
+
+

project object that needs to be created or updated.

+

+
+
+
+
+ /project +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing project
+

DELETE /business/projects/project/{project-name}

+ Tags: + Business +
+
+
+

delete an existing project

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

+ 		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 /business/projects/project/{project-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

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/v12/BusinessProjectsProject.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /business/projects/project/{project-name}/relationship-list/relationship

+ Tags: + Business +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cloud-regions
+

GET /cloud-infrastructure/cloud-regions

+ Tags: + CloudInfrastructure +
+
+
+

returns cloud-regions

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /cloud-regions +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cloud-region
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns cloud-region

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /cloud-region +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing cloud-region
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+

cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)

+

+
+
+
+
+ /cloud-region +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing cloud-region
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /cloud-region +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing cloud-region
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing cloud-region

+ +
+
+ +

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 + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns availability-zones
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones

+ Tags: + CloudInfrastructure +
+
+
+

returns availability-zones

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /availability-zones +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns availability-zone
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns availability-zone

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a 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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /availability-zone +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing availability-zone
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+

availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

+

+
+
+
+
+ /availability-zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing availability-zone
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /availability-zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing availability-zone
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing availability-zone

+ +
+
+ +

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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a 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}/availability-zones/availability-zone/{availability-zone-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/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a 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}/availability-zones/availability-zone/{availability-zone-name}/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 + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns dvs-switches
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches

+ Tags: + CloudInfrastructure +
+
+
+

returns dvs-switches

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /dvs-switches +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns dvs-switch
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns dvs-switch

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ switch-name + +

DVS switch name

+ 		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 + + +
+ vcenter-url + +

URL used to reach the vcenter

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /dvs-switch +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing dvs-switch
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing dvs-switch

+ +
+
+ +

application/json application/xml +

+
+
+

dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+
+ /dvs-switch +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ switch-name + +

DVS switch name

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing dvs-switch
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing dvs-switch

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /dvs-switch +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ switch-name + +

DVS switch name

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing dvs-switch
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing dvs-switch

+ +
+
+ +

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 + + + +
+ switch-name + +

DVS switch name

+ 		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}/dvs-switches/dvs-switch/{switch-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/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ switch-name + +

DVS switch name

+ 		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}/dvs-switches/dvs-switch/{switch-name}/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 + + + +
+ switch-name + +

DVS switch name

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns flavors
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns flavors

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ flavor-name + +

Flavor name

+ 		query + string + + +
+
+ +
+

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/v12/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 + +

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

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

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 created or updated.

+

+
+
+
+
+ /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 + +

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 flavor
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing flavor

+ +
+
+ +

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 + + + +
+ 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}/flavors/flavor/{flavor-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/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 + +

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

+ +
+
+
+ +
+
+ +
+ /group-assignments +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns group-assignment
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns group-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /group-assignment +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+ /group-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /group-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing group-assignment

+ +
+
+ +

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/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/group-assignments/group-assignment/{group-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 + + + +
+ group-id + +

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

+ 		path + 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 + +

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

+ +
+
+
+ +
+
+ +
+ /images +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns image
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns image

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /image +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing image
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing image

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing image
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing image

+ +
+
+ +

application/json application/xml +

+
+
+

image object that needs to be created or updated.

+

+
+
+
+
+ /image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing image
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing image

+ +
+
+ +

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 + + + +
+ image-id + +

Image 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ 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/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+ +

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 + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+ 		path + string + + + +
+ metaname + + 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}/images/image/{image-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/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/images/image/{image-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 + + + +
+ image-id + +

Image id, expected to be unique across cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns oam-networks
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

+ Tags: + CloudInfrastructure +
+
+
+

returns oam-networks

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /oam-networks +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns oam-network
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

returns oam-network

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ network-uuid + +

UUID of the network. Unique across a 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 + string + + +
+ network-name + +

Name of the network.

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

cvlan-id

+ 		query + integer + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /oam-network +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing oam-network
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+

oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

+

+
+
+
+
+ /oam-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing oam-network
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /oam-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing oam-network
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing oam-network

+ +
+
+ +

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 + + + +
+ network-uuid + +

UUID of the network. Unique across a 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}/oam-networks/oam-network/{network-uuid}/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/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ network-uuid + +

UUID of the network. Unique across a 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}/oam-networks/oam-network/{network-uuid}/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 + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+ 		path + 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}/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/v12/CloudInfrastructureCloudRegionsCloudRegion.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns snapshots
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+
+ +
+
+ +
+ /snapshots +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ snapshot-id + +

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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /snapshot +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing snapshot
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /snapshot +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing snapshot
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+

snapshot object that needs to be created or updated.

+

+
+
+
+
+ /snapshot +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing snapshot
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing snapshot

+ +
+
+ +

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 + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+ 		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}/snapshots/snapshot/{snapshot-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/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+ 		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}/snapshots/snapshot/{snapshot-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 + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tenants
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /tenant +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing tenant
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing tenant

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /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 +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing tenant
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing tenant

+ +
+
+ +

application/json application/xml +

+
+
+

tenant object that needs to be created or updated.

+

+
+
+
+
+ /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 +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing tenant
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing tenant

+ +
+
+ +

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 + + + +
+ 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}/tenants/tenant/{tenant-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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 +

+ +
+
+ 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}/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 + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vservers
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vservers

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vserver
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vserver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vserver +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

create or update an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+

vserver object that needs to be created or updated.

+

+
+
+
+
+ /vserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing vserver

+ +
+
+ +

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 + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing l-interface

+ +
+
+ +

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 + + + +
+ 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 /cloud-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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 l3-interface-ipv4-address-list

+ +
+
+ +

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 + + + +
+ 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 /cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		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}/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 + + + +
+ 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 + + + +
+ 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 /cloud-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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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}/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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		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}/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 +
+
+
+

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 + + + +
+ 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-ipv6-address + +

IP address

+ 		path + 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}/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/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 + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		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 + 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 + + +
+
+ +
+

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 /cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-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-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 + + + +
+ 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 /cloud-infrastructure/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 + + +
+ vpn-key + +

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 /cloud-infrastructure/cloud-regions/cloud-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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		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 + 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		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 + 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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-ipv6-address-list

+ +
+
+ +

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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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 /cloud-infrastructure/cloud-regions/cloud-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 +
+
+
+

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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + 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}/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 + + + +
+ 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 + + + +
+
+ +
+

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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns volumes

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /volumes +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 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 + +

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 + +

Unique ID of block storage volume relative to the vserver.

+ 		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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /volume +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 volume

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /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 + +

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 + +

Unique ID of block storage volume relative to the vserver.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 volume

+ +
+
+ +

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 + +

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 + +

Unique ID of block storage volume relative to the vserver.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 volume

+ +
+
+ +

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 + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+ 		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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Unique ID of block storage volume relative to the vserver.

+ 		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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-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 + + + +
+ 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 + +

Unique ID of block storage volume relative to the vserver.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vip-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv4-address + +

IP address

+ 		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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vip-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

+

+
+
+
+
+ /vip-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vip-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vip-ipv4-address-list

+ +
+
+ +

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 + + + +
+ vip-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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-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/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv4-address + +

IP address

+ 		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}/vip-ipv4-address-list/{vip-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 + + + +
+ cloud-region-id + +

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

+ 		path + string + + + +
+ vip-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vip-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

+
+
+
+
+ /vip-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vip-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-ipv6-address-list

+ +
+
+ +

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 + + + +
+ vip-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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-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/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ 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 + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /volume-groups +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /volume-group +
+
+
+ +
+
+ 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/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+
+ /volume-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing volume-group

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /volume-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 volume-group

+ +
+
+ +

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 + + + +
+ volume-group-id + +

Unique ID of volume-group.

+ 		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}/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/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns complexes
+

GET /cloud-infrastructure/complexes

+ Tags: + CloudInfrastructure +
+
+
+

returns complexes

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /complexes +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns complex
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns complex

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /complex +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing complex
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

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/v12/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+
+ /complex +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing complex
+

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing complex

+ +
+
+ +

application/json application/xml +

+
+
+

complex object that needs to be created or updated.

+

+
+
+
+
+ /complex +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing complex
+

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing complex

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-pools
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

+ Tags: + CloudInfrastructure +
+
+
+

returns ctag-pools

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-pools +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-pool
+

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns ctag-pool

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-pool +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

+
+
+
+
+ /ctag-pool +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+

ctag-pool object that needs to be created or updated.

+

+
+
+
+
+ /ctag-pool +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 ctag-pool

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

+ 		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/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-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/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +

Name of the availability zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/complexes/complex/{physical-location-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/v12/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ physical-location-id + +

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profiles
+

GET /cloud-infrastructure/network-profiles

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profiles

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /network-profiles +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profile
+

GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profile

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /network-profile +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing network-profile
+

PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+

network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+
+ /network-profile +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing network-profile
+

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /network-profile +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing network-profile
+

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing network-profile

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+ 		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/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/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

+ 		path + 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 +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ nm-profile-name + +

Unique name of network profile.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns operational-environments
+

GET /cloud-infrastructure/operational-environments

+ Tags: + CloudInfrastructure +
+
+
+

returns operational-environments

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /operational-environments +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns operational-environment
+

GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns operational-environment

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /operational-environment +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing operational-environment
+

PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+

operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

+

+
+
+
+
+ /operational-environment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing operational-environment
+

PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+

operational-environment object that needs to be created or updated.

+

+
+
+
+
+ /operational-environment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing operational-environment
+

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing operational-environment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

+ 		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/operational-environments/operational-environment/{operational-environment-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/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + +

UUID of an operational environment

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pserver
+

GET /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

returns pserver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /pserver +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing pserver
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /pserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pserver
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+

pserver object that needs to be created or updated.

+

+
+
+
+
+ /pserver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + 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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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 + +

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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ 		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 /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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /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 + 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 + + + +
+ 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 + + +
+
+ +
+

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/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ vlan-interface + +

String that identifies 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ vlan-interface + +

String that identifies the interface

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

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}/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/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the physical 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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}

+ 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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + 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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ 		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 /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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

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 + + + +
+ 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 + + +
+
+ +
+

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/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 vlan

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}

+ Tags: + CloudInfrastructure +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + 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}/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}

+ 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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + 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}/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 /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 +
+
+
+

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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/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/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the physical interface

+ 		path + 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}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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/v12/CloudInfrastructurePserversPserver.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

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

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /virtual-data-centers +
+
+
+ +
+
+ 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 + + + +
+ vdc-name + +

Name of the virtual data center

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /virtual-data-center +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+

virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+
+ /virtual-data-center +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing virtual-data-center
+

PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+

virtual-data-center object that needs to be created or updated.

+

+
+
+
+
+ /virtual-data-center +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing virtual-data-center
+

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+ 		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/virtual-data-centers/virtual-data-center/{vdc-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/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns configurations
+

GET /network/configurations

+ Tags: + Network +
+
+
+

returns configurations

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /configurations +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns configuration
+

GET /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

returns configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /configuration +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing configuration
+

PUT /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing configuration
+

PATCH /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

update an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+

configuration object that needs to be created or updated.

+

+
+
+
+
+ /configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing configuration
+

DELETE /network/configurations/configuration/{configuration-id}

+ Tags: + Network +
+
+
+

delete an existing configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns evcs
+

GET /network/configurations/configuration/{configuration-id}/evcs

+ Tags: + Network +
+
+
+

returns evcs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /evcs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns evc
+

GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

returns evc

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+ 		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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /evc +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing evc
+

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

create or update an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing evc
+

PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

update an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+

evc object that needs to be created or updated.

+

+
+
+
+
+ /evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing evc
+

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

+ Tags: + Network +
+
+
+

delete an existing evc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

+ 		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/configurations/configuration/{configuration-id}/evcs/evc/{evc-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/v12/NetworkConfigurationsConfigurationEvcsEvc.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ evc-id + +

Unique/key field for the evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder-evcs
+

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

+ Tags: + Network +
+
+
+

returns forwarder-evcs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarder-evcs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder-evc
+

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

returns forwarder-evc

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+ 		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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarder-evc +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarder-evc
+

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

create or update an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)

+

+
+
+
+
+ /forwarder-evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarder-evc
+

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

update an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder-evc object that needs to be created or updated.

+

+
+
+
+
+ /forwarder-evc +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarder-evc
+

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

+ Tags: + Network +
+
+
+

delete an existing forwarder-evc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

+ 		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/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-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/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ forwarder-evc-id + +

Key for forwarder-evc object

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

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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ metaname + + 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 + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

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/v12/NetworkConfigurationsConfigurationMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

+ Tags: + Network +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

+ 		path + string + + + +
+ metaname + + 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/configurations/configuration/{configuration-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/v12/NetworkConfigurationsConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ configuration-id + +

UUID assigned to configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarding-paths
+

GET /network/forwarding-paths

+ Tags: + Network +
+
+
+

returns forwarding-paths

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarding-paths +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarding-path
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

returns forwarding-path

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ forwarding-path-name + +

Name of the FP

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarding-path +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarding-path
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

create or update an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+

forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)

+

+
+
+
+
+ /forwarding-path +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarding-path
+

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

update an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+

forwarding-path object that needs to be created or updated.

+

+
+
+
+
+ /forwarding-path +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarding-path
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

+ Tags: + Network +
+
+
+

delete an existing forwarding-path

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarders
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

+ Tags: + Network +
+
+
+

returns forwarders

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ forwarding-path-name + +

Name of the FP

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarders +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns forwarder
+

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

returns forwarder

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+ forwarding-path-name + +

Name of the FP

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /forwarder +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing forwarder
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

create or update an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /forwarder +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing forwarder
+

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

update an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+

forwarder object that needs to be created or updated.

+

+
+
+
+
+ /forwarder +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing forwarder
+

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

+ Tags: + Network +
+
+
+

delete an existing forwarder

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+ 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/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/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/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

+ 		path + string + + + +
+ sequence + +

Unique ID of this segmentation

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-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/v12/NetworkForwardingPathsForwardingPath.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + +

Unique ID of this FP

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

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

+ +
+
+
+ +
+
+ +
+ /generic-vnfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns generic-vnf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

returns generic-vnf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /generic-vnf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing generic-vnf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

create or update an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)

+

+
+
+
+
+ /generic-vnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing generic-vnf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

+ Tags: + Network +
+
+
+

update an existing generic-vnf

+ +
+
+ +

application/json application/xml +

+
+
+

generic-vnf object that needs to be created or updated.

+

+
+
+
+
+ /generic-vnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+ 		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

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing entitlement
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /entitlement +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing entitlement
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+
+ /entitlement +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing entitlement
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+ 		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}/entitlements/entitlement/{group-uuid}/{resource-uuid}/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/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

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 + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 created or updated.

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		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}/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 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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}/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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /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 + + + +
+ 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.

+

+
+
+
+
+ /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 + + + +
+ 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}/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 + +
+
+
+
+

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-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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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.

+ 		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}/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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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/v12/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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-key + +

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/v12/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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ 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/v12/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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-key + +

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/v12/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 + +

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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ 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}/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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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}/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.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

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}/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 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 + + + +
+ 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}/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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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-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 + + + +
+ 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}/lag-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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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 + + + +
+ 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}/lag-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 created or updated.

+

+
+
+
+
+ /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 + + + +
+ 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}/lag-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 +
+
+
+

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 + + + +
+ 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}/lag-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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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}/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 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-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}/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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns licenses
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

+ Tags: + Network +
+
+
+

returns licenses

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns license

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + 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

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

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/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing license
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing license

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + 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}/licenses/license/{group-uuid}/{resource-uuid}/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/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + 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}/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/v12/NetworkGenericVnfsGenericVnf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		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}/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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vf-modules
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

+ Tags: + Network +
+
+
+

returns vf-modules

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /vf-modules +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vf-module
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

returns vf-module

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+ 		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 + + +
+ 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 + +

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 + + +
+ contrail-service-instance-fqdn + +

the Contrail unique ID for a service-instance

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vf-module +
+
+
+ +
+
+ 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/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+
+ /vf-module +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+ 		path + 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 created or updated.

+

+
+
+
+
+ /vf-module +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vf-module

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+ 		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}/vf-modules/vf-module/{vf-module-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/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

+ 		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}/vf-modules/vf-module/{vf-module-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 + + + +
+ vf-module-id + +

Unique ID of vf-module.

+ 		path + 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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /instance-groups +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns instance-group
+

GET /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

returns instance-group

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /instance-group +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing instance-group
+

PUT /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

create or update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /instance-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing instance-group
+

PATCH /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /instance-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing instance-group
+

DELETE /network/instance-groups/instance-group/{id}

+ Tags: + Network +
+
+
+

delete an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

+ 		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/instance-groups/instance-group/{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/v12/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group 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/instance-groups/instance-group/{id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configurations
+

GET /network/ipsec-configurations

+ Tags: + Network +
+
+
+

returns ipsec-configurations

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ipsec-configurations +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configuration
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

returns ipsec-configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ipsec-configuration +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing ipsec-configuration
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+
+ /ipsec-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ipsec-configuration
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

update an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

ipsec-configuration object that needs to be created or updated.

+

+
+
+
+
+ /ipsec-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ipsec-configuration
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

delete an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-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/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vig-servers
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

+ Tags: + Network +
+
+
+

returns vig-servers

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vig-servers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vig-server
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

returns vig-server

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vig-server +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+
+ /vig-server +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vig-server
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+ Tags: + Network +
+
+
+

update an existing vig-server

+ +
+
+ +

application/json application/xml +

+
+
+

vig-server object that needs to be created or updated.

+

+
+
+
+
+ /vig-server +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 vig-server

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/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/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-networks
+

GET /network/l3-networks

+ Tags: + Network +
+
+
+

returns l3-networks

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-networks +
+
+
+ +
+
+ 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 + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-network +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-network
+

PUT /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

create or update an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+

l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)

+

+
+
+
+
+ /l3-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-network
+

PATCH /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

update an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-network +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-network
+

DELETE /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

delete an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-assignments
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

+ Tags: + Network +
+
+
+

returns ctag-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

+ +
+
+
+ +
+
+ +
+ /ctag-assignments +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ctag-assignment
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

returns ctag-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-assignment +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing ctag-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

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/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

+
+
+
+
+ /ctag-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ctag-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

update an existing ctag-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /ctag-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ctag-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+ Tags: + Network +
+
+
+

delete an existing ctag-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+ 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/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/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/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-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/v12/NetworkL3NetworksL3Network.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns segmentation-assignments
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

+ Tags: + Network +
+
+
+

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

+ +
+
+
+ +
+
+ +
+ /segmentation-assignments +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /segmentation-assignment +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing segmentation-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

create or update an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /segmentation-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing segmentation-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

update an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /segmentation-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ segmentation-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 segmentation-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

delete an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

+ 		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/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-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/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ segmentation-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/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-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 + + + +
+ segmentation-id + +

Route Table Reference id, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns subnets
+

GET /network/l3-networks/l3-network/{network-id}/subnets

+ Tags: + Network +
+
+
+

returns subnets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /subnets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns subnet
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

returns subnet

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		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 + + +
+ subnet-name + +

Name associated with the subnet.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /subnet +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing subnet
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

create or update an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /subnet +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing subnet
+

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

update an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+

subnet object that needs to be created or updated.

+

+
+
+
+
+ /subnet +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing subnet
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+ Tags: + Network +
+
+
+

delete an existing subnet

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns host-routes
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

+ Tags: + Network +
+
+
+

returns host-routes

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		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 + + +
+ subnet-name + +

Name associated with the subnet.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /host-routes +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

+ 		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 + + +
+ subnet-name + +

Name associated with the subnet.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /host-route +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+
+ /host-route +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

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

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 created or updated.

+

+
+
+
+
+ /host-route +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

+ 		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/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-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/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-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/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 + +

Subnet ID, should be UUID.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-links
+

GET /network/lag-links

+ Tags: + Network +
+
+
+

returns lag-links

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-link
+

GET /network/lag-links/lag-link/{link-name}

+ Tags: + Network +
+
+
+

returns lag-link

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing lag-link
+

PUT /network/lag-links/lag-link/{link-name}

+ Tags: + Network +
+
+
+

create or update an existing lag-link

+ +
+
+ +

application/json application/xml +

+
+
+

lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)

+

+
+
+
+
+ /lag-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing lag-link
+

PATCH /network/lag-links/lag-link/{link-name}

+ Tags: + Network +
+
+
+

update an existing lag-link

+ +
+
+ +

application/json application/xml +

+
+
+

lag-link object that needs to be created or updated.

+

+
+
+
+
+ /lag-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing lag-link
+

DELETE /network/lag-links/lag-link/{link-name}

+ Tags: + Network +
+
+
+

delete an existing lag-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

+ 		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/lag-links/lag-link/{link-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/v12/NetworkLagLinksLagLink.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

Alphabetical concatenation of lag-interface names

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns logical-links
+

GET /network/logical-links

+ Tags: + Network +
+
+
+

returns logical-links

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /logical-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns logical-link
+

GET /network/logical-links/logical-link/{link-name}

+ Tags: + Network +
+
+
+

returns logical-link

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		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 + 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 + +

Reason for this entity, role it is playing

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /logical-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing logical-link
+

PUT /network/logical-links/logical-link/{link-name}

+ Tags: + Network +
+
+
+

create or update an existing logical-link

+ +
+
+ +

application/json application/xml +

+
+
+

logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)

+

+
+
+
+
+ /logical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing logical-link
+

PATCH /network/logical-links/logical-link/{link-name}

+ Tags: + Network +
+
+
+

update an existing logical-link

+ +
+
+ +

application/json application/xml +

+
+
+

logical-link object that needs to be created or updated.

+

+
+
+
+
+ /logical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing logical-link
+

DELETE /network/logical-links/logical-link/{link-name}

+ Tags: + Network +
+
+
+

delete an existing logical-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+ 		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/logical-links/logical-link/{link-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/v12/NetworkLogicalLinksLogicalLink.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns multicast-configurations
+

GET /network/multicast-configurations

+ Tags: + Network +
+
+
+

returns multicast-configurations

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /multicast-configurations +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns multicast-configuration
+

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

returns multicast-configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /multicast-configuration +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing multicast-configuration
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

create or update an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+
+
+
+ /multicast-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing multicast-configuration
+

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

update an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

multicast-configuration object that needs to be created or updated.

+

+
+
+
+
+ /multicast-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing multicast-configuration
+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+ Tags: + Network +
+
+
+

delete an existing multicast-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

+ 		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/multicast-configurations/multicast-configuration/{multicast-configuration-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/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ multicast-configuration-id + +

Unique id of multicast configuration.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policies
+

GET /network/network-policies

+ Tags: + Network +
+
+
+

returns network-policies

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /network-policies +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-policy
+

GET /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

returns network-policy

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+ 		path + string + + + +
+ network-policy-fqdn + +

Contrail FQDN for the policy

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /network-policy +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing network-policy
+

PUT /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

create or update an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+

network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+
+ /network-policy +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing network-policy
+

PATCH /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

update an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /network-policy +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing network-policy
+

DELETE /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

delete an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

+ 		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/network-policies/network-policy/{network-policy-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/v12/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ network-policy-id + +

UUID representing unique key to this instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvces
+

GET /network/newvces

+ Tags: + Network +
+
+
+

returns newvces

+ +
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /newvce +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing newvce
+

PUT /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

create or update an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /newvce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing newvce
+

PATCH /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

update an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+

newvce object that needs to be created or updated.

+

+
+
+
+
+ /newvce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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.

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 created or updated.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + +

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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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 + + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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-key + +

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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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 + + +
+ 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/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 +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

+ 		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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/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/v12/NetworkNewvcesNewvce.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns physical-links
+

GET /network/physical-links

+ Tags: + Network +
+
+
+

returns physical-links

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /physical-links +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns physical-link
+

GET /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

returns physical-link

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		path + string + + + +
+ circuit-id + +

Circuit it

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /physical-link +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing physical-link
+

PUT /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

create or update an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+

physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)

+

+
+
+
+
+ /physical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing physical-link
+

PATCH /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

update an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+

physical-link object that needs to be created or updated.

+

+
+
+
+
+ /physical-link +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing physical-link
+

DELETE /network/physical-links/physical-link/{link-name}

+ Tags: + Network +
+
+
+

delete an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+ 		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/physical-links/physical-link/{link-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/v12/NetworkPhysicalLinksPhysicalLink.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ link-name + +

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pnfs
+

GET /network/pnfs

+ Tags: + Network +
+
+
+

returns pnfs

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /pnfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns pnf
+

GET /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

returns pnf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /pnf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing pnf
+

PUT /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

create or update an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /pnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pnf
+

PATCH /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

update an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+

pnf object that needs to be created or updated.

+

+
+
+
+
+ /pnf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing pnf
+

DELETE /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

delete an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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/pnfs/pnf/{pnf-name}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

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 + 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/pnfs/pnf/{pnf-name}/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/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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/pnfs/pnf/{pnf-name}/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.

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

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 + 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 + 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 + + + +
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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 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/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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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 + 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 created or updated.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

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

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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/pnfs/pnf/{pnf-name}/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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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-key + +

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/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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 + + + +
+ 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/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 +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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}/lag-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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ 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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/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/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-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/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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 relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the link aggregate interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns p-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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 + + +
+ prov-status + +

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

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical 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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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 + + +
+ prov-status + +

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

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-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.

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

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 + + + +
+ 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/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 +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

delete an existing l3-interface-ipv6-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-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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ 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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

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

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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

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-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/pnfs/pnf/{pnf-name}/p-interfaces/p-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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

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/pnfs/pnf/{pnf-name}/p-interfaces/p-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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-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 +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ 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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ 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-key + +

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/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/pnfs/pnf/{pnf-name}/p-interfaces/p-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 + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 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 + + + +
+ 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/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 relationship

+ +
+
+ +

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 + + + +
+ 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/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ vlan-interface + +

String that identifies 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 created or updated.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 l3-interface-ipv6-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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 relationship

+ +
+
+ +

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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

delete an existing relationship

+ +
+
+ +

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 + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-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/v12/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

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

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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + Network +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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 + + +
+ prov-status + +

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

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		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 + + +
+ prov-status + +

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

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+ 		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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-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/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-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/v12/NetworkPnfsPnf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

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 +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-references
+

GET /network/route-table-references

+ Tags: + Network +
+
+
+

returns route-table-references

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /route-table-references +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-reference
+

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

returns route-table-reference

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+ 		path + string + + + +
+ route-table-reference-fqdn + +

FQDN entry in the route table.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /route-table-reference +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing route-table-reference
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

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/v12/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+
+
+
+ /route-table-reference +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing route-table-reference
+

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

update an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+

route-table-reference object that needs to be created or updated.

+

+
+
+
+
+ /route-table-reference +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 route-table-reference
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

delete an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ route-table-reference-id + +

Route Table Reference id, UUID assigned to this instance.

+ 		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/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/v12/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair-sets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pair-set
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

returns site-pair-set

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair-set +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing site-pair-set
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

create or update an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+
+ /site-pair-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing site-pair-set
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

update an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair-set object that needs to be created or updated.

+

+
+
+
+
+ /site-pair-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing site-pair-set
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+ Tags: + Network +
+
+
+

delete an existing site-pair-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		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/site-pair-sets/site-pair-set/{site-pair-set-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/v12/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns routing-instances
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

+ Tags: + Network +
+
+
+

returns routing-instances

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /routing-instances +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns routing-instance
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

returns routing-instance

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /routing-instance +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing routing-instance
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

create or update an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+

routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+
+ /routing-instance +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing routing-instance
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

update an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /routing-instance +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing routing-instance
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+ Tags: + Network +
+
+
+

delete an existing routing-instance

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		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/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pairs
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

+ Tags: + Network +
+
+
+

returns site-pairs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pairs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns site-pair
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

returns site-pair

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing site-pair
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

create or update an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

+

+
+
+
+
+ /site-pair +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing site-pair
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

update an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+

site-pair object that needs to be created or updated.

+

+
+
+
+
+ /site-pair +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing site-pair
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

+ Tags: + Network +
+
+
+

delete an existing site-pair

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns classes-of-service
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

+ Tags: + Network +
+
+
+

returns classes-of-service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /classes-of-service +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns class-of-service
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

returns class-of-service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /class-of-service +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing class-of-service
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

create or update an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+

class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

+

+
+
+
+
+ /class-of-service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing class-of-service
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

update an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+

class-of-service object that needs to be created or updated.

+

+
+
+
+
+ /class-of-service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing class-of-service
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

+ Tags: + Network +
+
+
+

delete an existing class-of-service

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

+ 		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/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+ 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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

+ 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/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ site-pair-set-id + +

Unique id of site pair set.

+ 		path + string + + + +
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vces
+

GET /network/vces

+ Tags: + Network +
+
+
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vce +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vce
+

PUT /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

create or update an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vce
+

PATCH /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

update an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+

vce object that needs to be created or updated.

+

+
+
+
+
+ /vce +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vce
+

DELETE /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlements
+

GET /network/vces/vce/{vnf-id}/entitlements

+ Tags: + Network +
+
+
+

returns entitlements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns entitlement

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+ 		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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing entitlement
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

create or update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /entitlement +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing entitlement
+

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+
+ /entitlement +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing entitlement
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing entitlement

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

+ 		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/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/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/v12/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

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/vces/vce/{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 + string + + + +
+ group-uuid + +

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns licenses
+

GET /network/vces/vce/{vnf-id}/licenses

+ Tags: + Network +
+
+
+

returns licenses

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns license
+

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns license

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing license
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

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/v12/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing license
+

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

delete an existing license

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + 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/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/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/v12/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vces/vce/{vnf-id}/licenses/license/{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 + 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 + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns port-groups
+

GET /network/vces/vce/{vnf-id}/port-groups

+ Tags: + Network +
+
+
+

returns port-groups

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /port-groups +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns port-group
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

returns port-group

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /port-group +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing port-group
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

create or update an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /port-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing port-group
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

update an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /port-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing port-group
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+ Tags: + Network +
+
+
+

delete an existing port-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns cvlan-tags
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

+ Tags: + Network +
+
+
+

returns cvlan-tags

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of 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 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /cvlan-tags +
+
+
+ +
+
+ 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /cvlan-tag-entry +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing cvlan-tag-entry
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

create or update an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+

cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+
+ /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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing cvlan-tag-entry
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

update an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+

cvlan-tag-entry object that needs to be created or updated.

+

+
+
+
+
+ /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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing cvlan-tag-entry
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+ Tags: + Network +
+
+
+

delete an existing cvlan-tag-entry

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/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/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/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-id + +

Unique ID of the interface

+ 		path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-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/v12/NetworkVcesVcePortGroupsPortGroup.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-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-id + +

Unique ID of the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{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/v12/NetworkVcesVce.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vces/vce/{vnf-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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnfcs
+

GET /network/vnfcs

+ Tags: + Network +
+
+
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+ 		query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

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

prov status of this vnfc

+ 		query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+ 		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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vnfc +
+
+
+ +
+
+ default + +
+
+
+
+

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/v12/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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

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

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

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

IP address

+ 		path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+ 		query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

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

prov status of this vnfc

+ 		query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+ 		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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vnfcs/vnfc/{vnfc-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/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-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/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ nfc-naming-code + +

Short code that is used in naming instances of the item being modeled

+ 		query + string + + +
+ nfc-function + +

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

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

prov status of this vnfc

+ 		query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+ 		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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vnfcs/vnfc/{vnfc-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/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-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/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

+ 		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/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/v12/NetworkVnfcsVnfc.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnfc-name + +

Unique ID of vnfc.

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

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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vpls-pe +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

create or update an existing vpls-pe

+ +
+
+ +

application/json application/xml +

+
+
+

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)

+

+
+
+
+
+ /vpls-pe +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vpls-pe
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

+ Tags: + Network +
+
+
+

update an existing vpls-pe

+ +
+
+ +

application/json application/xml +

+
+
+

vpls-pe object that needs to be created or updated.

+

+
+
+
+
+ /vpls-pe +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/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.

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/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.

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/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 + + 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 + + + +
+ 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 + + +
+ 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + +
+
+
+
+

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}/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 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/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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 + 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

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 created or updated.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

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

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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/vpls-pes/vpls-pe/{equipment-name}/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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 + + + +
+ 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 + + +
+ 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/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 sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ 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 + + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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-key + +

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/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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ l3-interface-ipv4-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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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}/lag-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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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 + 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-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/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

Name that identifies the link aggregate interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-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

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns p-interface

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

Name that identifies the physical interface

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

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/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /p-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing p-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing p-interface

+ +
+
+ +

application/json application/xml +

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

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

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

Name that identifies the physical interface

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

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

Name that identifies the physical 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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.

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

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 + + + +
+ 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}/p-interfaces/p-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 + + 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 + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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}

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

delete an existing l3-interface-ipv6-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-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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

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

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-ipv6-address-list/{l3-interface-ipv6-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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + Network +
+
+
+

returns sriov-vfs

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

Name that identifies the physical 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 + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 + + + +
+ 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 + + +
+
+ +
+

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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + 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 + + + +
+
+ +
+

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}/sriov-vfs/sriov-vf/{pci-id}/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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

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

Name that identifies the physical 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 + + +
+ 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 + + +
+
+ +
+

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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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-key + +

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/vpls-pes/vpls-pe/{equipment-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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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 +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

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 + + + +
+ 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}/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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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}/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ 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/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 +
+
+
+

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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

+ 		path + string + + + +
+ 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-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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

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.

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/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 +
+
+
+

delete an existing l3-interface-ipv6-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 + + + +
+ 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-ipv6-address + +

IP address

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

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}/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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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-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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ 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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

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}/vlans/vlan/{vlan-interface}/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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + Network +
+
+
+

returns sriov-pfs

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

Name that identifies the physical interface

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

returns sriov-pf

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+ 		path + string + + + +
+ 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 + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

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

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+ 		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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-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/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

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}/sriov-pfs/sriov-pf/{pf-pci-id}/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 + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-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/v12/NetworkVplsPesVplsPe.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + 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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vpn-bindings +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vpn-binding
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

returns vpn-binding

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+ 		path + string + + + +
+ vpn-name + +

VPN Name

+ 		query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vpn-binding +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vpn-binding
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

create or update an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+

vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+
+ /vpn-binding +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vpn-binding
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

update an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+

vpn-binding object that needs to be created or updated.

+

+
+
+
+
+ /vpn-binding +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vpn-binding
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

+ Tags: + Network +
+
+
+

delete an existing vpn-binding

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+ 		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/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/v12/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

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

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vpn-id + +

VPN ID, globally unique within A&AI

+ 		path + string + + + +
+ vpn-name + +

VPN Name

+ 		query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /route-targets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-target
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

returns route-target

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+ vpn-name + +

VPN Name

+ 		query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /route-target +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing route-target
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

create or update an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+

route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+
+ /route-target +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing route-target
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+ Tags: + Network +
+
+
+

update an existing route-target

+ +
+
+ +

application/json application/xml +

+
+
+

route-target object that needs to be created or updated.

+

+
+
+
+
+ /route-target +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing relationship

+ +
+
+ +

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 + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns zones
+

GET /network/zones

+ Tags: + Network +
+
+
+

returns zones

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /zones +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns zone
+

GET /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

returns zone

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+ 		path + string + + + +
+ design-type + +

Design of zone [Medium/Largeā€¦]

+ 		query + string + + +
+ zone-context + +

Context of zone [production/test]

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /zone +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing zone
+

PUT /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

create or update an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing zone
+

PATCH /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

update an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+

zone object that needs to be created or updated.

+

+
+
+
+
+ /zone +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing zone
+

DELETE /network/zones/zone/{zone-id}

+ Tags: + Network +
+
+
+

delete an existing zone

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+ 		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/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/v12/NetworkZonesZone.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ zone-id + +

Code assigned by AIC to the zone

+ 		path + 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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /models +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model
+

GET /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model
+

PUT /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /model +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model

+ +
+
+ +

application/json application/xml +

+
+
+

model object that needs to be created or updated.

+

+
+
+
+
+ /model +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-vers
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-vers

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-vers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-ver
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-ver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-ver +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-ver
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+

model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

+
+
+
+
+ /model-ver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model-ver
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+

model-ver object that needs to be created or updated.

+

+
+
+
+
+ /model-ver +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model-ver
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model-ver

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

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

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns metadata

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns metadatum

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ metaname + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ metaname + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-elements
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-elements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-elements +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-element
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-element

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-element +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing model-element
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+

model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

+

+
+
+
+
+ /model-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing model-element
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+

model-element object that needs to be created or updated.

+

+
+
+
+
+ /model-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing model-element
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing model-element

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-constraints
+

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

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-constraints

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-constraints +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-constraint
+

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}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-constraint

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /model-constraint +
+
+
+ +
+
+ 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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

+

+
+
+
+
+ /model-constraint +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

model-constraint object that needs to be created or updated.

+

+
+
+
+
+ /model-constraint +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing model-constraint

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns constrained-element-sets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-sets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-set

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-set +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+
+
+
+ /constrained-element-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

update an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated.

+

+
+
+
+
+ /constrained-element-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

returns element-choice-sets

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /element-choice-sets +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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-set

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+ 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 + + +
+ distribution-status + +

Distribution Status

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /element-choice-set +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+
+
+
+ /element-choice-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

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 created or updated.

+

+
+
+
+
+ /element-choice-set +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+

delete an existing element-choice-set

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + 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 /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 +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + 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}/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 relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + 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}/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 +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + 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}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
+ model-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + 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}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + string + + + +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationModelsModel.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ model-invariant-id + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + 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 + +

Unique identifier corresponding to the main definition of a model in ASDC

+ 		path + 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 +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /named-queries +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /named-query +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing named-query
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+

named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

+

+
+
+
+
+ /named-query +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing named-query
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+

named-query object that needs to be created or updated.

+

+
+
+
+
+ /named-query +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing named-query
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query-elements
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query-elements

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /named-query-elements +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns named-query-element
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns named-query-element

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /named-query-element +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing named-query-element
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+

named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

+

+
+
+
+
+ /named-query-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing named-query-element
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+

named-query-element object that needs to be created or updated.

+

+
+
+
+
+ /named-query-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing named-query-element
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns property-constraints
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns property-constraints

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /property-constraints +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns property-constraint
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns property-constraint

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /property-constraint +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing property-constraint
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)

+

+
+
+
+
+ /property-constraint +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing property-constraint
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

property-constraint object that needs to be created or updated.

+

+
+
+
+
+ /property-constraint +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing property-constraint
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ property-constraint-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns related-lookups
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns related-lookups

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /related-lookups +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns related-lookup
+

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns related-lookup

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+ named-query-name + + query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /related-lookup +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing related-lookup
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing related-lookup

+ +
+
+ +

application/json application/xml +

+
+
+

related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

+

+
+
+
+
+ /related-lookup +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing related-lookup
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing related-lookup

+ +
+
+ +

application/json application/xml +

+
+
+

related-lookup object that needs to be created or updated.

+

+
+
+
+
+ /related-lookup +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing related-lookup
+

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing related-lookup

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + 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 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-capabilities
+

GET /service-design-and-creation/service-capabilities

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service-capabilities

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /service-capabilities +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-capability
+

GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service-capability

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /service-capability +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service-capability
+

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+

service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

+

+
+
+
+
+ /service-capability +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service-capability
+

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /service-capability +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service-capability
+

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

+ 		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 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-type + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + 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.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns services
+

GET /service-design-and-creation/services

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns services

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /services +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service
+

GET /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns service

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + string + + + +
+ service-description + +

Description of the service

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /service +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service
+

PUT /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing service

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing service
+

PATCH /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing service

+ +
+
+ +

application/json application/xml +

+
+
+

service object that needs to be created or updated.

+

+
+
+
+
+ /service +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing service
+

DELETE /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing service

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		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 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationServicesService.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnf-images
+

GET /service-design-and-creation/vnf-images

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns vnf-images

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vnf-images +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnf-image
+

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns vnf-image

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+ 		path + 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

+ +
+
+
+ +
+
+ +
+ /vnf-image +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vnf-image
+

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)

+

+
+
+
+
+ /vnf-image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vnf-image
+

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated.

+

+
+
+
+
+ /vnf-image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vnf-image
+

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+ 		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 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

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/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +

Schema definitions

+ +
+
+

aai-internal: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

action: + object + + + +

+
+
+ +
+
+
+ action-type: + string + + +
+
+
+ +
+
+
+ action-data: + object[] + + +
+
+ +
+ +
+ action-data + + + +
+ +
+
+
+
+
+
+
+
+
+

action-data: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

actions: + object + + + +

+
+
+
+

APIs that are more action related than REST (e.g., notify, update).

+ +
+ +
+
+
+ update: + object + + +
+
+ +
+ +
+ update + + + +
+ +
+
+
+
+ notify: + object + + +
+
+ +
+ +
+ notify + + + +
+ +
+
+
+
+
+
+
+
+
+

allotted-resource: + object + + + +

+
+
+
+

Represents a slice or partial piece of a resource that gets separately allotted

+ +
    +
  • TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
    • +
  • TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
    • +
  • TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
    • +
  • TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
    • +
  • TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
    • +
  • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • +
  • FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
    • +
  • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ +
+ +
+
+
+ id: + string + + + +
+
+

Allotted Resource id UUID assigned to this instance.

+
+ +
+
+
+ description: + string + + +
+
+

The descriptive information assigned to this allotted resource instance

+
+ +
+
+
+ selflink: + string + + +
+
+

Link back to more information in the controller

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ type: + string + + +
+
+

Generic description of the type of allotted resource.

+
+ +
+
+
+ role: + string + + +
+
+

role in the network that this resource will be providing.

+
+ +
+
+
+ tunnel-xconnects: + object[] + + +
+
+ +
+ +
+ tunnel-xconnect + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

allotted-resources: + object + + + +

+
+
+
+

This object is used to store slices of services being offered

+ +
+ +
+
+
+ allotted-resource: + object[] + + +
+
+ +
+ +
+ allotted-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

availability-zone: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ availability-zone-name: + string + + + +
+
+

Name of the availability zone. Unique across a cloud region

+
+ +
+
+
+ hypervisor-type: + string + + + +
+
+

Type of hypervisor. Source of truth should define valid values.

+
+ +
+
+
+ operational-status: + string + + +
+
+

State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

availability-zones: + object + + + +

+
+
+
+

Collection of availability zones

+ +
+ +
+
+
+ availability-zone: + object[] + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+
+
+
+
+
+

az-and-dvs-switches: + object + + + +

+
+
+ +
+
+
+ dvs-switches: + object + + +
+
+ +
+ +
+ dvs-switches + + + +
+ +
+
+
+
+ availability-zone: + object + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+
+
+
+
+
+

business: + object + + + +

+
+
+
+

Namespace for business related constructs

+ +
+ +
+
+
+ connectors: + object[] + + +
+
+ +
+ +
+ connector + + + +
+ +
+
+
+
+ customers: + object[] + + +
+
+ +
+ +
+ customer + + + +
+ +
+
+
+
+ lines-of-business: + object[] + + +
+
+ +
+ +
+ line-of-business + + + +
+ +
+
+
+
+ owning-entities: + object[] + + +
+
+ +
+ +
+ owning-entity + + + +
+ +
+
+
+
+ platforms: + object[] + + +
+
+ +
+ +
+ platform + + + +
+ +
+
+
+
+ projects: + object[] + + +
+
+ +
+ +
+ project + + + +
+ +
+
+
+
+
+
+
+
+
+

class-of-service: + object + + + +

+
+
+
+ +
    +
  • TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ +
+ +
+
+
+ cos: + string + + + +
+
+

unique identifier of probe

+
+ +
+
+
+ probe-id: + string + + +
+
+

identifier of probe

+
+ +
+
+
+ probe-type: + string + + +
+
+

type of probe

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

classes-of-service: + object + + + +

+
+
+
+

class-of-service of probe

+ +
+ +
+
+
+ class-of-service: + object[] + + +
+
+ +
+ +
+ class-of-service + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-infrastructure: + object + + + +

+
+
+
+

Namespace for cloud infrastructure.

+ +
+ +
+
+
+ complexes: + object[] + + +
+
+ +
+ +
+ complex + + + +
+ +
+
+
+
+ cloud-regions: + object[] + + +
+
+ +
+ +
+ cloud-region + + + +
+ +
+
+
+
+ network-profiles: + object[] + + +
+
+ +
+ +
+ network-profile + + + +
+ +
+
+
+
+ pservers: + object[] + + +
+
+ +
+ +
+ pserver + + + +
+ +
+
+
+
+ virtual-data-centers: + object[] + + +
+
+ +
+ +
+ virtual-data-center + + + +
+ +
+
+
+
+ operational-environments: + object[] + + +
+
+ +
+ +
+ operational-environment + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-region: + object + + + +

+
+
+
+

cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname

+ +
    +
  • TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
    • +
  • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
    • +
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
    • +
  • CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ cloud-owner: + string + + + +
+
+

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

+
+ +
+
+
+ cloud-region-id: + string + + + +
+
+

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

+
+ +
+
+
+ cloud-type: + string + + +
+
+

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

+
+ +
+
+
+ owner-defined-type: + string + + +
+
+

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

+
+ +
+
+
+ cloud-region-version: + string + + +
+
+

Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

+
+ +
+
+
+ identity-url: + string + + +
+
+

URL of the keystone identity service

+
+ +
+
+
+ cloud-zone: + string + + +
+
+

Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

+
+ +
+
+
+ complex-name: + string + + +
+
+

complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

+
+ +
+
+
+ sriov-automation: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ volume-groups: + object[] + + +
+
+ +
+ +
+ volume-group + + + +
+ +
+
+
+
+ tenants: + object[] + + +
+
+ +
+ +
+ tenant + + + +
+ +
+
+
+
+ flavors: + object[] + + +
+
+ +
+ +
+ flavor + + + +
+ +
+
+
+
+ group-assignments: + object[] + + +
+
+ +
+ +
+ group-assignment + + + +
+ +
+
+
+
+ snapshots: + object[] + + +
+
+ +
+ +
+ snapshot + + + +
+ +
+
+
+
+ images: + object[] + + +
+
+ +
+ +
+ image + + + +
+ +
+
+
+
+ dvs-switches: + object[] + + +
+
+ +
+ +
+ dvs-switch + + + +
+ +
+
+
+
+ oam-networks: + object[] + + +
+
+ +
+ +
+ oam-network + + + +
+ +
+
+
+
+ availability-zones: + object[] + + +
+
+ +
+ +
+ availability-zone + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ vip-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ vip-ipv4-address-list + + + +
+ +
+
+
+
+ vip-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ vip-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-regions: + object + + + +

+
+
+ +
+
+
+ cloud-region: + object[] + + +
+
+ +
+ +
+ cloud-region + + + +
+ +
+
+
+
+
+
+
+
+
+

complex: + object + + + +

+
+
+
+

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 generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
    • +
  • COMPLEX is DELETED when these are DELETED CTAG-POOL
+ +
+ +
+
+
+ physical-location-id: + string + + + +
+
+

Unique identifier for physical location, e.g., CLLI

+
+ +
+
+
+ data-center-code: + string + + +
+
+

Data center code which can be an alternate way to identify a complex

+
+ +
+
+
+ complex-name: + string + + +
+
+

Gamma complex name for LCP instance.

+
+ +
+
+
+ identity-url: + string + + +
+
+

URL of the keystone identity service

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ physical-location-type: + string + + + +
+
+

Type, e.g., central office, data center.

+
+ +
+
+
+ street1: + string + + + +
+
+
+ +
+
+
+ street2: + string + + +
+
+
+ +
+
+
+ city: + string + + + +
+
+
+ +
+
+
+ state: + string + + +
+
+
+ +
+
+
+ postal-code: + string + + + +
+
+
+ +
+
+
+ country: + string + + + +
+
+
+ +
+
+
+ region: + string + + + +
+
+
+ +
+
+
+ latitude: + string + + +
+
+
+ +
+
+
+ longitude: + string + + +
+
+
+ +
+
+
+ elevation: + string + + +
+
+
+ +
+
+
+ lata: + string + + +
+
+
+ +
+
+
+ ctag-pools: + object[] + + +
+
+ +
+ +
+ ctag-pool + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

complexes: + object + + + +

+
+
+
+

Collection of physical locations that can house cloud-regions.

+ +
+ +
+
+
+ complex: + object[] + + +
+
+ +
+ +
+ complex + + + +
+ +
+
+
+
+
+
+
+
+
+

configuration: + object + + + +

+
+
+
+

Generic configuration object.

+ +
    +
  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
    • +
  • TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
    • +
  • FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
    • +
  • FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • +
  • FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • +
  • CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
    • +
  • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ +
+ +
+
+
+ configuration-id: + string + + + +
+
+

UUID assigned to configuration.

+
+ +
+
+
+ management-option: + string + + +
+
+

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

+
+ +
+
+
+ configuration-name: + string + + +
+
+

Name of the configuration.

+
+ +
+
+
+ configuration-type: + string + + + +
+
+

port-mirroring-configuration.

+
+ +
+
+
+ configuration-sub-type: + string + + + +
+
+

vprobe, pprobe.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of the configuration.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational.

+
+ +
+
+
+ configuration-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details from SDN-GC.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

id of the configuration used to customize the resource

+
+ +
+
+
+ tunnel-bandwidth: + string + + +
+
+

DHV Site Effective Bandwidth

+
+ +
+
+
+ vendor-allowed-max-bandwidth: + string + + +
+
+

Velocloud Nominal Throughput - VNT

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ forwarder-evcs: + object[] + + +
+
+ +
+ +
+ forwarder-evc + + + +
+ +
+
+
+
+ evcs: + object[] + + +
+
+ +
+ +
+ evc + + + +
+ +
+
+
+
+
+
+
+
+
+

configurations: + object + + + +

+
+
+
+

Collection of configurations

+ +
+ +
+
+
+ configuration: + object[] + + +
+
+ +
+ +
+ configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

connector: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ resource-instance-id: + string + + + +
+
+

Unique id of resource instance.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

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

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

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

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

connectors: + object + + + +

+
+
+
+

Collection of resource instances used to connect a variety of disparate inventory widgets

+ +
+ +
+
+
+ connector: + object[] + + +
+
+ +
+ +
+ connector + + + +
+ +
+
+
+
+
+
+
+
+
+

constrained-element-set: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ constrained-element-set-uuid: + string + + + +
+
+
+ +
+
+
+ constraint-type: + string + + + +
+
+
+ +
+
+
+ check-type: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ element-choice-sets: + object[] + + +
+
+ +
+ +
+ element-choice-set + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

constrained-element-sets: + object + + + +

+
+
+ +
+
+
+ constrained-element-set: + object[] + + +
+
+ +
+ +
+ constrained-element-set + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-assignment: + object + + + +

+
+
+
+ +
    +
  • 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)
+ +
+ +
+
+
+ vlan-id-inner: + integer + + + +
+
+

id.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-assignments: + object + + + +

+
+
+ +
+
+
+ ctag-assignment: + object[] + + +
+
+ +
+ +
+ ctag-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-pool: + object + + + +

+
+
+
+

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 generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ +
+ +
+
+
+ target-pe: + string + + + +
+
+

The Target provider edge router

+
+ +
+
+
+ availability-zone-name: + string + + + +
+
+

Name of the availability zone

+
+ +
+
+
+ ctag-pool-purpose: + string + + + +
+
+

Describes what the intended purpose of this pool is.

+
+ +
+
+
+ ctag-values: + string + + +
+
+

Comma separated list of ctags

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

ctag-pools: + object + + + +

+
+
+ +
+
+
+ ctag-pool: + object[] + + +
+
+ +
+ +
+ ctag-pool + + + +
+ +
+
+
+
+
+
+
+
+
+

customer: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ global-customer-id: + string + + + +
+
+

Global customer id used across ECOMP to uniquely identify customer.

+
+ +
+
+
+ subscriber-name: + string + + + +
+
+

Subscriber name, an alternate way to retrieve a customer.

+
+ +
+
+
+ subscriber-type: + string + + + +
+
+

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

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-subscriptions: + object[] + + +
+
+ +
+ +
+ service-subscription + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

customers: + object + + + +

+
+
+
+

Collection of customer identifiers to provide linkage back to BSS information.

+ +
+ +
+
+
+ customer: + object[] + + +
+
+ +
+ +
+ customer + + + +
+ +
+
+
+
+
+
+
+
+
+

cvlan-tag-entry: + object + + + +

+
+
+ +
+
+
+ cvlan-tag: + integer + + + +
+
+

See mis-na-virtualization-platform.yang

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

cvlan-tags: + object + + + +

+
+
+ +
+
+
+ cvlan-tag-entry: + object[] + + +
+
+ +
+ +
+ cvlan-tag-entry + + + +
+ +
+
+
+
+
+
+
+
+
+

dvs-switch: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ switch-name: + string + + + +
+
+

DVS switch name

+
+ +
+
+
+ vcenter-url: + string + + + +
+
+

URL used to reach the vcenter

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

dvs-switches: + object + + + +

+
+
+
+

Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

+ +
+ +
+
+
+ dvs-switch: + object[] + + +
+
+ +
+ +
+ dvs-switch + + + +
+ +
+
+
+
+
+
+
+
+
+

edge-prop-names: + object + + + +

+
+
+
+

Internal map to define the properties of an edge and interpret the map EdgeRules

+ +
+ +
+
+
+ edgeLabel: + string + + +
+
+
+ +
+
+
+ direction: + string + + +
+
+
+ +
+
+
+ multiplicityRule: + string + + +
+
+
+ +
+
+
+ contains-other-v: + string + + +
+
+
+ +
+
+
+ delete-other-v: + string + + +
+
+
+ +
+
+
+ SVC-INFRA: + string + + +
+
+
+ +
+
+
+ prevent-delete: + string + + +
+
+
+ +
+
+
+ aai-uuid: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

edge-tag-query-request: + object + + + +

+
+
+ +
+
+
+ edge-tag: + string + + +
+
+
+ +
+
+
+ result-detail: + string + + +
+
+
+ +
+
+
+ start-node-type: + string + + +
+
+
+ +
+
+
+ start-node-filter: + object[] + + +
+
+ +
+ +
+ start-node-filter + + + +
+ +
+
+
+
+ include-node-filter: + object[] + + +
+
+ +
+ +
+ include-node-filter + + + +
+ +
+
+
+
+ secondary-filter: + object[] + + +
+
+ +
+ +
+ secondary-filter + + + +
+ +
+
+
+
+
+
+
+
+
+

edge-tag-query-result: + object + + + +

+
+
+ +
+
+
+ tagged-inventory-item-list: + object[] + + +
+
+ +
+ +
+ tagged-inventory-item-list + + + +
+ +
+
+
+
+
+
+
+
+
+

element-choice-set: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ element-choice-set-uuid: + string + + + +
+
+
+ +
+
+
+ element-choice-set-name: + string + + + +
+
+
+ +
+
+
+ cardinality: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

element-choice-sets: + object + + + +

+
+
+ +
+
+
+ element-choice-set: + object[] + + +
+
+ +
+ +
+ element-choice-set + + + +
+ +
+
+
+
+
+
+
+
+
+

entitlement: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ group-uuid: + string + + + +
+
+

Unique ID for the entitlement group the resource comes from, should be uuid.

+
+ +
+
+
+ resource-uuid: + string + + + +
+
+

Unique ID of an entitlement resource.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

entitlements: + object + + + +

+
+
+
+

Entitlements, keyed by group-uuid and resource-uuid, related to license management

+ +
+ +
+
+
+ entitlement: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-ems: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ ems-id: + string + + + +
+
+

Unique ID of EMS.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-ems-list: + object + + + +

+
+
+ +
+
+
+ esr-ems: + object[] + + +
+
+ +
+ +
+ esr-ems + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-system-info: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ esr-system-info-id: + string + + + +
+
+

Unique ID of esr system info.

+
+ +
+
+
+ system-name: + string + + +
+
+

name of external system.

+
+ +
+
+
+ type: + string + + +
+
+

type of external systems.

+
+ +
+
+
+ vendor: + string + + +
+
+

vendor of external systems.

+
+ +
+
+
+ version: + string + + +
+
+

version of external systems.

+
+ +
+
+
+ service-url: + string + + +
+
+

url used to access external systems.

+
+ +
+
+
+ user-name: + string + + + +
+
+

username used to access external systems.

+
+ +
+
+
+ password: + string + + + +
+
+

password used to access external systems.

+
+ +
+
+
+ system-type: + string + + + +
+
+

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+
+ +
+
+
+ protocol: + string + + +
+
+

protocol of third party SDNC, for example netconf/snmp.

+
+ +
+
+
+ ssl-cacert: + string + + +
+
+

ca file content if enabled ssl on auth-url.

+
+ +
+
+
+ ssl-insecure: + boolean + + +
+
+

Whether to verify VIM's certificate.

+
+ +
+
+
+ ip-address: + string + + +
+
+

service IP of ftp server.

+
+ +
+
+
+ port: + string + + +
+
+

service port of ftp server.

+
+ +
+
+
+ cloud-domain: + string + + +
+
+

domain info for authentication.

+
+ +
+
+
+ default-tenant: + string + + +
+
+

default tenant of VIM.

+
+ +
+
+
+ passive: + boolean + + +
+
+

ftp passive mode or not.

+
+ +
+
+
+ remote-path: + string + + +
+
+

resource or performance data file path.

+
+ +
+
+
+ system-status: + string + + +
+
+

the status of external system.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-system-info-list: + object + + + +

+
+
+
+

Collection of persistent block-level external system auth info.

+ +
+ +
+
+
+ esr-system-info: + object[] + + +
+
+ +
+ +
+ esr-system-info + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-thirdparty-sdnc: + object + + + +

+
+
+
+

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 pnf( esr-thirdparty-sdnc has pnf, One2Many)
    • +
  • ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ +
+ +
+
+
+ thirdparty-sdnc-id: + string + + + +
+
+

Unique ID of SDNC.

+
+ +
+
+
+ location: + string + + +
+
+

used for DC type to indicate the location of SDNC, such as Core or Edge.

+
+ +
+
+
+ product-name: + string + + +
+
+

password used to access SDNC server.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-thirdparty-sdnc-list: + object + + + +

+
+
+ +
+
+
+ esr-thirdparty-sdnc: + object[] + + +
+
+ +
+ +
+ esr-thirdparty-sdnc + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-vnfm: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vnfm-id: + string + + + +
+
+

Unique ID of VNFM.

+
+ +
+
+
+ vim-id: + string + + +
+
+

indecate the VIM to deploy VNF.

+
+ +
+
+
+ certificate-url: + string + + +
+
+

certificate url of VNFM.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ esr-system-info-list: + object + + +
+
+ +
+ +
+ esr-system-info-list + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

esr-vnfm-list: + object + + + +

+
+
+ +
+
+
+ esr-vnfm: + object[] + + +
+
+ +
+ +
+ esr-vnfm + + + +
+ +
+
+
+
+
+
+
+
+
+

evc: + object + + + +

+
+
+
+

evc object is an optional child object of the Configuration object.

+ +
    +
  • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ +
+ +
+
+
+ evc-id: + string + + + +
+
+

Unique/key field for the evc object

+
+ +
+
+
+ forwarding-path-topology: + string + + +
+
+

Point-to-Point, Multi-Point

+
+ +
+
+
+ cir-value: + string + + +
+
+

Commited Information Rate

+
+ +
+
+
+ cir-units: + string + + +
+
+

CIR units

+
+ +
+
+
+ connection-diversity-group-id: + string + + +
+
+

Diversity Group ID

+
+ +
+
+
+ service-hours: + string + + +
+
+

formerly Performance Group

+
+ +
+
+
+ esp-evc-circuit-id: + string + + +
+
+

EVC Circuit ID of ESP EVC

+
+ +
+
+
+ esp-evc-cir-value: + string + + +
+
+

Committed Information Rate (For ESP)

+
+ +
+
+
+ esp-evc-cir-units: + string + + +
+
+

CIR units (For ESP)

+
+ +
+
+
+ esp-itu-code: + string + + +
+
+

Identifies ESP

+
+ +
+
+
+ collector-pop-clli: + string + + +
+
+

Collector POP CLLI (from the hostname of the access pnf)

+
+ +
+
+
+ inter-connect-type-ingress: + string + + +
+
+

Interconnect type on ingress side of EVC.

+
+ +
+
+
+ tagmode-access-ingress: + string + + +
+
+

tagode for collector side of EVC

+
+ +
+
+
+ tagmode-access-egress: + string + + +
+
+

tagMode for network side of EVC

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

evcs: + object + + + +

+
+
+ +
+
+
+ evc: + object[] + + +
+
+ +
+ +
+ evc + + + +
+ +
+
+
+
+
+
+
+
+
+

external-system: + object + + + +

+
+
+
+

Namespace for external system.

+ +
+ +
+
+
+ esr-ems-list: + object + + +
+
+ +
+ +
+ esr-ems-list + + + +
+ +
+
+
+
+ esr-vnfm-list: + object + + +
+
+ +
+ +
+ esr-vnfm-list + + + +
+ +
+
+
+
+ esr-thirdparty-sdnc-list: + object + + +
+
+ +
+ +
+ esr-thirdparty-sdnc-list + + + +
+ +
+
+
+
+
+
+
+
+
+

extra-properties: + object + + + +

+
+
+
+

Extra properties for inventory item for response list

+ +
+ +
+
+
+ extra-property: + object[] + + +
+
+ +
+ +
+ extra-property + + + +
+ +
+
+
+
+
+
+
+
+
+

extra-property: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

flavor: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ flavor-id: + string + + + +
+
+

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

+
+ +
+
+
+ flavor-name: + string + + + +
+
+

Flavor name

+
+ +
+
+
+ flavor-vcpus: + integer + + +
+
+

Number of CPUs

+
+ +
+
+
+ flavor-ram: + integer + + +
+
+

Amount of memory

+
+ +
+
+
+ flavor-disk: + integer + + +
+
+

Disk space

+
+ +
+
+
+ flavor-ephemeral: + integer + + +
+
+

Amount of ephemeral disk space

+
+ +
+
+
+ flavor-swap: + string + + +
+
+

amount of swap space allocation

+
+ +
+
+
+ flavor-is-public: + boolean + + +
+
+

whether flavor is available to all users or private to the tenant it was created in.

+
+ +
+
+
+ flavor-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ flavor-disabled: + boolean + + +
+
+

Boolean as to whether this flavor is no longer enabled

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

flavors: + object + + + +

+
+
+
+

Collection of openstack flavors.

+ +
+ +
+
+
+ flavor: + object[] + + +
+
+ +
+ +
+ flavor + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ sequence: + integer + + + +
+
+

Unique ID of this segmentation

+
+ +
+
+
+ forwarder-role: + string + + +
+
+

ingress, intermediate, egress

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder-evc: + object + + + +

+
+
+
+

forwarder object is an optional child object of the Configuration object.

+ +
    +
  • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ +
+ +
+
+
+ forwarder-evc-id: + string + + + +
+
+

Key for forwarder-evc object

+
+ +
+
+
+ circuit-id: + string + + +
+
+

Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

+
+ +
+
+
+ ivlan: + string + + +
+
+

Internal VLAN.

+
+ +
+
+
+ svlan: + string + + +
+
+

SVLAN value for ingress of egress forwarder.

+
+ +
+
+
+ cvlan: + string + + +
+
+

CVLAN value for ingress of egress forwarder.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarder-evcs: + object + + + +

+
+
+ +
+
+
+ forwarder-evc: + object[] + + +
+
+ +
+ +
+ forwarder-evc + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarders: + object + + + +

+
+
+ +
+
+
+ forwarder: + object[] + + +
+
+ +
+ +
+ forwarder + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarding-path: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ forwarding-path-id: + string + + + +
+
+

Unique ID of this FP

+
+ +
+
+
+ forwarding-path-name: + string + + + +
+
+

Name of the FP

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ selflink: + string + + +
+
+

the self link for this FP

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ forwarders: + object[] + + +
+
+ +
+ +
+ forwarder + + + +
+ +
+
+
+
+
+
+
+
+
+

forwarding-paths: + object + + + +

+
+
+ +
+
+
+ forwarding-path: + object[] + + +
+
+ +
+ +
+ forwarding-path + + + +
+ +
+
+
+
+
+
+
+
+
+

generic-vnf: + object + + + +

+
+
+
+

General purpose VNF

+ +
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • +
  • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • +
  • TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
    • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • +
  • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
    • +
  • GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+ vnf-instance-id: + string + + + +
+
+

vnf instance id.

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+
+ +
+
+
+ regional-resource-zone: + string + + +
+
+

Regional way of organizing pservers, source of truth should define values

+
+ +
+
+
+ prov-status: + string + + +
+
+

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

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, used by MSO.

+
+ +
+
+
+ vnf-package-name: + string + + + +
+
+
+ +
+
+
+ vnf-discriptor-name: + string + + + +
+
+

vnf discriptor name

+
+ +
+
+
+ job-id: + string + + + +
+
+

job id corresponding to vnf

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ management-option: + string + + +
+
+

identifier of managed by ATT or customer

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

v4 Loopback0 address

+
+ +
+
+
+ nm-lan-v6-address: + string + + +
+
+

v6 Loopback address

+
+ +
+
+
+ management-v6-address: + string + + +
+
+

v6 management address

+
+ +
+
+
+ vcpu: + integer + + +
+
+

number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vcpu-units: + string + + +
+
+

units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vmemory: + integer + + +
+
+

number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vmemory-units: + string + + +
+
+

units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ vdisk: + integer + + +
+
+

number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE

+
+ +
+
+
+ vdisk-units: + string + + +
+
+

units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE

+
+ +
+
+
+ nshd: + integer + + +
+
+

number of associated SHD in vnf.

+
+ +
+
+
+ nvm: + integer + + +
+
+

number of vms in vnf.

+
+ +
+
+
+ nnet: + integer + + +
+
+

number of network in vnf.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ summary-status: + string + + +
+
+

details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.

+
+ +
+
+
+ encrypted-access-flag: + boolean + + +
+
+

indicates whether generic-vnf access uses SSH

+
+ +
+
+
+ entitlement-assignment-group-uuid: + string + + +
+
+

UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.

+
+ +
+
+
+ entitlement-resource-uuid: + string + + +
+
+

UUID of the specific entitlement resource. OBSOLETE - See child relationships.

+
+ +
+
+
+ license-assignment-group-uuid: + string + + +
+
+

UUID of the license assignment group. OBSOLETE - See child relationships.

+
+ +
+
+
+ license-key-uuid: + string + + +
+
+

UUID of the actual license resource. OBSOLETE - See child relationships.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

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

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

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

+
+ +
+
+
+ as-number: + string + + +
+
+

as-number of the VNF

+
+ +
+
+
+ regional-resource-subzone: + string + + +
+
+

represents sub zone of the rr plane

+
+ +
+
+
+ nf-type: + string + + +
+
+

Generic description of the type of NF

+
+ +
+
+
+ nf-function: + string + + +
+
+

English description of Network function that the specific VNF deployment is providing

+
+ +
+
+
+ nf-role: + string + + +
+
+

role in the network that this model will be providing

+
+ +
+
+
+ nf-naming-code: + string + + +
+
+

string assigned to this model used for naming purposes

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ ipv4-oam-gateway-address: + string + + +
+
+

Gateway address

+
+ +
+
+
+ ipv4-oam-gateway-address-prefix-length: + integer + + +
+
+

Prefix length for oam-address

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Temporary location for S-TAG to get to VCE

+
+ +
+
+
+ nm-profile-name: + string + + +
+
+

Network Management profile of this VNF

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+ vf-modules: + object[] + + +
+
+ +
+ +
+ vf-module + + + +
+ +
+
+
+
+ licenses: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+ entitlements: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+
+
+
+
+
+

generic-vnfs: + object + + + +

+
+
+
+

Collection of VNFs

+ +
+ +
+
+
+ generic-vnf: + object[] + + +
+
+ +
+ +
+ generic-vnf + + + +
+ +
+
+
+
+
+
+
+
+
+

group-assignment: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ group-id: + string + + + +
+
+

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

+
+ +
+
+
+ group-type: + string + + + +
+
+

Group type - the type of group this instance refers to

+
+ +
+
+
+ group-name: + string + + + +
+
+

Group name - name assigned to the group

+
+ +
+
+
+ group-description: + string + + +
+
+

Group description - description of the group

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

group-assignments: + object + + + +

+
+
+
+

Collection of openstack group assignments

+ +
+ +
+
+
+ group-assignment: + object[] + + +
+
+ +
+ +
+ group-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

host-route: + object + + + +

+
+
+
+ +
    +
  • TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ +
+ +
+
+
+ host-route-id: + string + + + +
+
+

host-route id

+
+ +
+
+
+ route-prefix: + string + + + +
+
+

subnet prefix

+
+ +
+
+
+ next-hop: + string + + + +
+
+

Could be ip-address, hostname, or service-instance

+
+ +
+
+
+ next-hop-type: + string + + +
+
+

Should be ip-address, hostname, or service-instance to match next-hop

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

host-routes: + object + + + +

+
+
+ +
+
+
+ host-route: + object[] + + +
+
+ +
+ +
+ host-route + + + +
+ +
+
+
+
+
+
+
+
+
+

image: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ image-id: + string + + + +
+
+

Image id, expected to be unique across cloud region

+
+ +
+
+
+ image-name: + string + + + +
+
+

Image name

+
+ +
+
+
+ image-architecture: + string + + +
+
+

Operating system architecture.

+
+ +
+
+
+ image-os-distro: + string + + + +
+
+

The common name of the operating system distribution in lowercase

+
+ +
+
+
+ image-os-version: + string + + + +
+
+

The operating system version as specified by the distributor.

+
+ +
+
+
+ application: + string + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ image-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

images: + object + + + +

+
+
+
+

Collectio of Openstack images.

+ +
+ +
+
+
+ image: + object[] + + +
+
+ +
+ +
+ image + + + +
+ +
+
+
+
+
+
+
+
+
+

include-node-filter: + object + + + +

+
+
+ +
+
+
+ include-node-type: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

instance-filter: + object + + + +

+
+
+
+

InstanceFilter for performing a named-query or model query

+ +
+ +
+
+
+
+
+
+
+
+

instance-filters: + object + + + +

+
+
+
+

InstanceFilters for performing a named-query or model query

+ +
+ +
+
+
+ instance-filter: + object[] + + +
+
+ +
+ +
+ instance-filter + + + +
+ +
+
+
+
+
+
+
+
+
+

instance-group: + object + + + +

+
+
+
+

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 l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ +
+ +
+
+
+ instance-group-role: + string + + + +
+
+

role of the instance group.

+
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + + +
+
+

ASDC model version uid for this resource model.

+
+ +
+
+
+ id: + string + + + +
+
+

Instance Group ID, UUID assigned to this instance.

+
+ +
+
+
+ description: + string + + + +
+
+

Descriptive text to help identify the usage of this instance-group

+
+ +
+
+
+ type: + string + + + +
+
+

Only valid value today is lower case ha for high availability

+
+ +
+
+
+ sub-type: + string + + +
+
+

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

instance-groups: + object + + + +

+
+
+
+

Collection of openstack route table references

+ +
+ +
+
+
+ instance-group: + object[] + + +
+
+ +
+ +
+ instance-group + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory: + object + + + +

+
+
+ +
+
+
+ search: + object + + +
+
+ +
+ +
+ search + + + +
+ +
+
+
+
+ actions: + object + + +
+
+ +
+ +
+ actions + + + +
+ +
+
+
+
+ cloud-infrastructure: + object + + +
+
+ +
+ +
+ cloud-infrastructure + + + +
+ +
+
+
+
+ external-system: + object + + +
+
+ +
+ +
+ external-system + + + +
+ +
+
+
+
+ business: + object + + +
+
+ +
+ +
+ business + + + +
+ +
+
+
+
+ service-design-and-creation: + object + + +
+
+ +
+ +
+ service-design-and-creation + + + +
+ +
+
+
+
+ network: + object + + +
+
+ +
+ +
+ network + + + +
+ +
+
+
+
+ aai-internal: + object + + +
+
+ +
+ +
+ aai-internal + + + +
+ +
+
+
+
+ nodes: + object[] + + +
+
+ +
+ +
+ aai-internal + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-item: + object + + + +

+
+
+ +
+
+
+ inventory-item-type: + string + + +
+
+
+ +
+
+
+ inventory-item-link: + string + + +
+
+
+ +
+
+
+ inventory-item-data: + object[] + + +
+
+ +
+ +
+ inventory-item-data + + + +
+ +
+
+
+
+ tagged-inventory-item-list: + object[] + + +
+
+ +
+ +
+ tagged-inventory-item-list + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-item-data: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

inventory-response-item: + object + + + +

+
+
+
+

Inventory item for response list

+ +
+ +
+
+
+ model-name: + string + + +
+
+
+ +
+
+
+ extra-properties: + object + + +
+
+ +
+ +
+ extra-properties + + + +
+ +
+
+
+
+ inventory-response-items: + object + + +
+
+ +
+ +
+ inventory-response-items + + + +
+ +
+
+
+
+
+
+
+
+
+

inventory-response-items: + object + + + +

+
+
+
+

Container for inventory items in response list

+ +
+ +
+
+
+ inventory-response-item: + object[] + + +
+
+ +
+ +
+ inventory-response-item + + + +
+ +
+
+
+
+
+
+
+
+
+

ipsec-configuration: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ ipsec-configuration-id: + string + + + +
+
+

UUID of this configuration

+
+ +
+
+
+ requested-vig-address-type: + string + + +
+
+

Indicate the type of VIG server like AVPN, INTERNET, BOTH

+
+ +
+
+
+ requested-encryption-strength: + string + + +
+
+

Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ requested-dmz-type: + string + + +
+
+

ATT can offer a shared DMZ or a DMZ specific to a customer

+
+ +
+
+
+ shared-dmz-network-address: + string + + +
+
+

Network address of shared DMZ

+
+ +
+
+
+ requested-customer-name: + string + + +
+
+

If the DMZ is a custom DMZ, this field will indicate the customer information

+
+ +
+
+
+ ike-version: + string + + +
+
+

can be 1 or 2

+
+ +
+
+
+ ikev1-authentication: + string + + +
+
+

Contains values like md5, sha1, sha256, sha384

+
+ +
+
+
+ ikev1-encryption: + string + + +
+
+

Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ ikev1-dh-group: + string + + +
+
+

Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14

+
+ +
+
+
+ ikev1-am-group-id: + string + + +
+
+

Group name defined in VIG for clients using aggressive mode

+
+ +
+
+
+ ikev1-am-password: + string + + +
+
+

pre-shared key for the above group name

+
+ +
+
+
+ ikev1-sa-lifetime: + string + + +
+
+

Lifetime for IKEv1 SA

+
+ +
+
+
+ ipsec-authentication: + string + + +
+
+

md5, sha1, sha256, sha384

+
+ +
+
+
+ ipsec-encryption: + string + + +
+
+

3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc

+
+ +
+
+
+ ipsec-sa-lifetime: + string + + +
+
+

Life time for IPSec SA

+
+ +
+
+
+ ipsec-pfs: + string + + +
+
+

enable PFS or not

+
+ +
+
+
+ xauth-userid: + string + + +
+
+

user ID for xAuth, sm-user,ucpeHostName,nmteHostName

+
+ +
+
+
+ xauth-user-password: + string + + +
+
+

Encrypted using the Juniper $9$ algorithm

+
+ +
+
+
+ dpd-interval: + string + + +
+
+

The time between DPD probe

+
+ +
+
+
+ dpd-frequency: + string + + +
+
+

Maximum number of DPD before claiming the tunnel is down

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ vig-servers: + object[] + + +
+
+ +
+ +
+ vig-server + + + +
+ +
+
+
+
+
+
+
+
+
+

ipsec-configurations: + object + + + +

+
+
+ +
+
+
+ ipsec-configuration: + object[] + + +
+
+ +
+ +
+ ipsec-configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

key-data: + object + + + +

+
+
+ +
+
+
+ key-name: + string + + +
+
+
+ +
+
+
+ key-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

l-interface: + object + + + +

+
+
+
+

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 allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
    • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name given to the interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

E.g., CUSTOMER, UPLINK, etc.

+
+ +
+
+
+ v6-wan-link-ip: + string + + +
+
+

Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ interface-id: + string + + +
+
+

ID of interface

+
+ +
+
+
+ macaddr: + string + + +
+
+

MAC address for the interface

+
+ +
+
+
+ network-name: + string + + +
+
+

Name of the network

+
+ +
+
+
+ management-option: + string + + +
+
+

Whether A&AI should be managing this interface of not. Could have value like CUSTOMER

+
+ +
+
+
+ interface-description: + string + + +
+
+

Human friendly text regarding this interface.

+
+ +
+
+
+ is-port-mirrored: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

+
+ +
+
+
+ is-ip-unnumbered: + boolean + + + +
+
+
+ +
+
+
+ allowed-address-pairs: + string + + +
+
+

Freeform field for storing an ip address, list of ip addresses or a subnet block.

+
+ +
+
+
+ vlans: + object[] + + +
+
+ +
+ +
+ vlan + + + +
+ +
+
+
+
+ sriov-vfs: + object[] + + +
+
+ +
+ +
+ sriov-vf + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

l-interfaces: + object + + + +

+
+
+
+

Collection of logical interfaces.

+ +
+ +
+
+
+ l-interface: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-interface-ipv4-address-list: + object + + + +

+
+
+
+

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 vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ +
+ +
+
+
+ l3-interface-ipv4-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ l3-interface-ipv4-prefix-length: + integer + + +
+
+

Prefix length, 32 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-interface-ipv6-address-list: + object + + + +

+
+
+
+

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 vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ +
+ +
+
+
+ l3-interface-ipv6-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ l3-interface-ipv6-prefix-length: + integer + + +
+
+

Prefix length, 128 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-network: + object + + + +

+
+
+
+

Generic network definition

+ +
    +
  • TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ +
+ +
+
+
+ network-id: + string + + + +
+
+

Network ID, should be uuid. Unique across A&AI.

+
+ +
+
+
+ network-name: + string + + + +
+
+

Name of the network, governed by some naming convention..

+
+ +
+
+
+ network-type: + string + + +
+
+

Type of the network - who defines these values?

+
+ +
+
+
+ network-role: + string + + +
+
+

Role the network plans - who defines these values?

+
+ +
+
+
+ network-technology: + string + + +
+
+

Network technology - who defines these values?

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of this Interface

+
+ +
+
+
+ is-bound-to-vpn: + boolean + + + +
+
+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+
+ +
+
+
+ network-role-instance: + integer + + +
+
+

network role instance

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ contrail-network-fqdn: + string + + +
+
+

Contrail FQDN for the network

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

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

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

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

+
+ +
+
+
+ physical-network-name: + string + + +
+
+

Name associated with the physical network.

+
+ +
+
+
+ is-provider-network: + boolean + + + +
+
+
+ +
+
+
+ is-shared-network: + boolean + + + +
+
+
+ +
+
+
+ is-external-network: + boolean + + + +
+
+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational.

+
+ +
+
+
+ subnets: + object[] + + +
+
+ +
+ +
+ subnet + + + +
+ +
+
+
+
+ ctag-assignments: + object[] + + +
+
+ +
+ +
+ ctag-assignment + + + +
+ +
+
+
+
+ segmentation-assignments: + object[] + + +
+
+ +
+ +
+ segmentation-assignment + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

l3-networks: + object + + + +

+
+
+ +
+
+
+ l3-network: + object[] + + +
+
+ +
+ +
+ l3-network + + + +
+ +
+
+
+
+
+
+
+
+
+

lag-interface: + object + + + +

+
+
+
+

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)
    • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
    • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name that identifies the link aggregate interface

+
+ +
+
+
+ interface-description: + string + + +
+
+

Human friendly text regarding this interface.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ interface-id: + string + + +
+
+

ID of interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
+ +
+
+
+ prov-status: + string + + +
+
+

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

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

lag-interfaces: + object + + + +

+
+
+
+

Collection of link aggregate interfaces.

+ +
+ +
+
+
+ lag-interface: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

license: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ group-uuid: + string + + + +
+
+

Unique ID for the license group the resource belongs to, should be uuid.

+
+ +
+
+
+ resource-uuid: + string + + + +
+
+

Unique ID of a license resource.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

licenses: + object + + + +

+
+
+
+

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

+ +
+ +
+
+
+ license: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+
+
+
+
+
+

line-of-business: + object + + + +

+
+
+
+

describes a line-of-business

+ +
    +
  • TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ line-of-business-name: + string + + + +
+
+

Name of the line-of-business (product)

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

lines-of-business: + object + + + +

+
+
+
+

Collection of lines-of-business

+ +
+ +
+
+
+ line-of-business: + object[] + + +
+
+ +
+ +
+ line-of-business + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

metadata: + object + + + +

+
+
+
+

Collection of metadatum (key/value pairs)

+ +
+ +
+
+
+ metadatum: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+
+
+
+
+
+

metadatum: + object + + + +

+
+
+
+

Key/value pairs

+ +
    +
  • TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • +
  • TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • +
  • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ +
+ +
+
+
+ metaname: + string + + + +
+
+
+ +
+
+
+ metaval: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+
+
+
+
+
+

model: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

Unique identifier corresponding to the main definition of a model in ASDC

+
+ +
+
+
+ model-type: + string + + + +
+
+

Type of the model, e.g., service, resource, widget, etc.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-vers: + object[] + + +
+
+ +
+ +
+ model-ver + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+ +
+
+

model-constraint: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ model-constraint-uuid: + string + + + +
+
+
+ +
+
+
+ constrained-element-set-uuid-to-replace: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ constrained-element-sets: + object[] + + +
+
+ +
+ +
+ constrained-element-set + + + +
+ +
+
+
+
+
+
+
+
+
+

model-constraints: + object + + + +

+
+
+ +
+
+
+ model-constraint: + object[] + + +
+
+ +
+ +
+ model-constraint + + + +
+ +
+
+
+
+
+
+
+
+
+

model-element: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ model-element-uuid: + string + + + +
+
+
+ +
+
+
+ new-data-del-flag: + string + + + +
+
+

Indicates whether this element was created as part of instantiation from this model

+
+ +
+
+
+ cardinality: + string + + + +
+
+

How many of this type of element are required/allowed

+
+ +
+
+
+ linkage-points: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ model-constraints: + object[] + + +
+
+ +
+ +
+ model-constraint + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

model-elements: + object + + + +

+
+
+ +
+
+
+ model-element: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+
+
+
+
+
+

model-ver: + object + + + +

+
+
+
+

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 metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
    • +
  • MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ +
+ +
+
+
+ model-version-id: + string + + + +
+
+

Unique identifier corresponding to one version of a model in ASDC

+
+ +
+
+
+ model-name: + string + + + +
+
+

Name of the model, which can change from version to version.

+
+ +
+
+
+ model-version: + string + + + +
+
+

Version

+
+ +
+
+
+ distribution-status: + string + + +
+
+

Distribution Status

+
+ +
+
+
+ model-description: + string + + +
+
+

Description

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-elements: + object[] + + +
+
+ +
+ +
+ model-element + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

model-vers: + object + + + +

+
+
+ +
+
+
+ model-ver: + object[] + + +
+
+ +
+ +
+ model-ver + + + +
+ +
+
+
+
+
+
+
+
+
+

models: + object + + + +

+
+
+
+

Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models

+ +
+ +
+
+
+ model: + object[] + + +
+
+ +
+ +
+ model + + + +
+ +
+
+
+
+
+
+
+
+
+

multicast-configuration: + object + + + +

+
+
+
+ +
    +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ +
+ +
+
+
+ multicast-configuration-id: + string + + + +
+
+

Unique id of multicast configuration.

+
+ +
+
+
+ multicast-protocol: + string + + + +
+
+

protocol of multicast configuration

+
+ +
+
+
+ rp-type: + string + + + +
+
+

rp type of multicast configuration

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

multicast-configurations: + object + + + +

+
+
+
+

multicast configuration of generic-vnf ip-address

+ +
+ +
+
+
+ multicast-configuration: + object[] + + +
+
+ +
+ +
+ multicast-configuration + + + +
+ +
+
+
+
+
+
+
+
+
+

named-queries: + object + + + +

+
+
+ +
+
+
+ named-query: + object[] + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ named-query-uuid: + string + + + +
+
+
+ +
+
+
+ named-query-name: + string + + + +
+
+
+ +
+
+
+ named-query-version: + string + + + +
+
+
+ +
+
+
+ required-input-param: + string + + +
+
+
+ +
+
+
+ description: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ named-query-elements: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query-element: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ named-query-element-uuid: + string + + + +
+
+
+ +
+
+
+ property-collect-list: + string + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+ property-limit-desc: + string + + +
+
+
+ +
+
+
+ do-not-output: + string + + +
+
+
+ +
+
+
+ named-query-elements: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+ related-lookups: + object[] + + +
+
+ +
+ +
+ related-lookup + + + +
+ +
+
+
+
+ property-constraints: + object[] + + +
+
+ +
+ +
+ property-constraint + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

named-query-elements: + object + + + +

+
+
+ +
+
+
+ named-query-element: + object[] + + +
+
+ +
+ +
+ named-query-element + + + +
+ +
+
+
+
+
+
+
+
+
+

network: + object + + + +

+
+
+
+

Namespace for network inventory resources.

+ +
+ +
+
+
+ logical-links: + object[] + + +
+
+ +
+ +
+ logical-link + + + +
+ +
+
+
+
+ site-pair-sets: + object[] + + +
+
+ +
+ +
+ site-pair-set + + + +
+ +
+
+
+
+ vpn-bindings: + object[] + + +
+
+ +
+ +
+ vpn-binding + + + +
+ +
+
+
+
+ vpls-pes: + object[] + + +
+
+ +
+ +
+ vpls-pe + + + +
+ +
+
+
+
+ multicast-configurations: + object[] + + +
+
+ +
+ +
+ multicast-configuration + + + +
+ +
+
+
+
+ vces: + object[] + + +
+
+ +
+ +
+ vce + + + +
+ +
+
+
+
+ vnfcs: + object[] + + +
+
+ +
+ +
+ vnfc + + + +
+ +
+
+
+
+ l3-networks: + object[] + + +
+
+ +
+ +
+ l3-network + + + +
+ +
+
+
+
+ network-policies: + object[] + + +
+
+ +
+ +
+ network-policy + + + +
+ +
+
+
+
+ generic-vnfs: + object[] + + +
+
+ +
+ +
+ generic-vnf + + + +
+ +
+
+
+
+ lag-links: + object[] + + +
+
+ +
+ +
+ lag-link + + + +
+ +
+
+
+
+ newvces: + object[] + + +
+
+ +
+ +
+ newvce + + + +
+ +
+
+
+
+ pnfs: + object[] + + +
+
+ +
+ +
+ pnf + + + +
+ +
+
+
+
+ physical-links: + object[] + + +
+
+ +
+ +
+ physical-link + + + +
+ +
+
+
+
+ ipsec-configurations: + object[] + + +
+
+ +
+ +
+ ipsec-configuration + + + +
+ +
+
+
+
+ route-table-references: + object[] + + +
+
+ +
+ +
+ route-table-reference + + + +
+ +
+
+
+
+ instance-groups: + object[] + + +
+
+ +
+ +
+ instance-group + + + +
+ +
+
+
+
+ zones: + object[] + + +
+
+ +
+ +
+ zone + + + +
+ +
+
+
+
+ configurations: + object[] + + +
+
+ +
+ +
+ configuration + + + +
+ +
+
+
+
+ forwarding-paths: + object[] + + +
+
+ +
+ +
+ forwarding-path + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policies: + object + + + +

+
+
+ +
+
+
+ network-policy: + object[] + + +
+
+ +
+ +
+ network-policy + + + +
+ +
+
+
+
+
+
+
+
+
+

network-policy: + object + + + +

+
+
+
+ +
    +
  • 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)
+ +
+ +
+
+
+ network-policy-id: + string + + + +
+
+

UUID representing unique key to this instance

+
+ +
+
+
+ network-policy-fqdn: + string + + +
+
+

Contrail FQDN for the policy

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

ID for the openStack Heat instance

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

network-profile: + object + + + +

+
+
+
+

Network profile populated by SDN-GP for SNMP

+ +
    +
  • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ nm-profile-name: + string + + + +
+
+

Unique name of network profile.

+
+ +
+
+
+ community-string: + string + + +
+
+

Encrypted SNMP community string

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

network-profiles: + object + + + +

+
+
+
+

Collection of network profiles

+ +
+ +
+
+
+ network-profile: + object[] + + +
+
+ +
+ +
+ network-profile + + + +
+ +
+
+
+
+
+
+
+
+
+

newvce: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vnf-id2: + string + + + +
+
+

Unique id of VNF, can't use same attribute name right now until we promote this new object

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

v4 Loopback0 address

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO.

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

newvces: + object + + + +

+
+
+
+

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

+ +
+ +
+
+
+ newvce: + object[] + + +
+
+ +
+ +
+ newvce + + + +
+ +
+
+
+
+
+
+
+
+
+

notification-event: + object + + + +

+
+
+ +
+
+
+ cambria.partition: + string + + +
+
+
+ +
+
+
+ notification-event-header: + object + + +
+
+ +
+ +
+ notification-event-header + + + +
+ +
+
+
+
+
+
+
+
+
+

notification-event-header: + object + + + +

+
+
+ +
+
+
+ id: + string + + +
+
+
+ +
+
+
+ timestamp: + string + + +
+
+
+ +
+
+
+ source-name: + string + + +
+
+
+ +
+
+
+ domain: + string + + +
+
+
+ +
+
+
+ sequence-number: + string + + +
+
+
+ +
+
+
+ severity: + string + + +
+
+
+ +
+
+
+ event-type: + string + + +
+
+
+ +
+
+
+ version: + string + + +
+
+
+ +
+
+
+ action: + string + + +
+
+
+ +
+
+
+ entity-type: + string + + +
+
+
+ +
+
+
+ top-entity-type: + string + + +
+
+
+ +
+
+
+ entity-link: + string + + +
+
+
+ +
+
+
+ status: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

notify: + object + + + +

+
+
+ +
+
+
+ event-id: + string + + + +
+
+
+ +
+
+
+ node-type: + string + + +
+
+
+ +
+
+
+ event-trigger: + string + + +
+
+
+ +
+
+
+ selflink: + string + + +
+
+
+ +
+
+
+ key-data: + object[] + + +
+
+ +
+ +
+ key-data + + + +
+ +
+
+
+
+
+
+
+
+
+

oam-network: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ network-uuid: + string + + + +
+
+

UUID of the network. Unique across a cloud-region

+
+ +
+
+
+ network-name: + string + + + +
+
+

Name of the network.

+
+ +
+
+
+ cvlan-tag: + integer + + + +
+
+

cvlan-id

+
+ +
+
+
+ ipv4-oam-gateway-address: + string + + +
+
+

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

+
+ +
+
+
+ ipv4-oam-gateway-address-prefix-length: + integer + + +
+
+

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

oam-networks: + object + + + +

+
+
+
+

Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.

+ +
+ +
+
+
+ oam-network: + object[] + + +
+
+ +
+ +
+ oam-network + + + +
+ +
+
+
+
+
+
+
+
+
+

operational-environment: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ operational-environment-id: + string + + + +
+
+

UUID of an operational environment

+
+ +
+
+
+ operational-environment-name: + string + + + +
+
+

Operational Environment name

+
+ +
+
+
+ operational-environment-type: + string + + + +
+
+

Operational Environment Type.

+
+ +
+
+
+ operational-environment-status: + string + + + +
+
+

Status

+
+ +
+
+
+ tenant-context: + string + + + +
+
+

Tenant Context.

+
+ +
+
+
+ workload-context: + string + + + +
+
+

Workload Context.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

operational-environments: + object + + + +

+
+
+
+

a logical partition of the cloud which allows to have multiple environments in the production AIC.

+ +
+ +
+
+
+ operational-environment: + object[] + + +
+
+ +
+ +
+ operational-environment + + + +
+ +
+
+
+
+
+
+
+
+
+

overloaded-model: + object + + + +

+
+
+
+

Allows for legacy POST of old-style and new-style models

+ +
+ +
+
+
+ model-invariant-id: + string + + + +
+
+

Unique identifier corresponding to the main definition of a model in ASDC

+
+ +
+
+
+ model-name-version-id: + string + + + +
+
+

Unique identifier corresponding to one version of a model in ASDC

+
+ +
+
+
+ model-type: + string + + + +
+
+

Type of the model, e.g., service, resource, widget, etc.

+
+ +
+
+
+ model-name: + string + + + +
+
+

Name of the model, which can change from version to version.

+
+ +
+
+
+ model-id: + string + + + +
+
+

Invariant unique ID which does not change from version to version

+
+ +
+
+
+ model-version: + string + + + +
+
+

Version

+
+ +
+
+
+ model-description: + string + + +
+
+

Description

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-vers: + object + + +
+
+ +
+ +
+ model-vers + + + +
+ +
+
+
+
+ relationship-list: + object + + +
+
+ +
+ +
+ relationship-list + + + +
+ +
+
+
+
+
+
+
+
+
+

owning-entities: + object + + + +

+
+
+
+

Collection of owning-entities

+ +
+ +
+
+
+ owning-entity: + object[] + + +
+
+ +
+ +
+ owning-entity + + + +
+ +
+
+
+
+
+
+
+
+
+

owning-entity: + object + + + +

+
+
+
+

describes an owning-entity

+ +
    +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ +
+ +
+
+
+ owning-entity-id: + string + + + +
+
+

UUID of an owning entity

+
+ +
+
+
+ owning-entity-name: + string + + + +
+
+

Owning entity name

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

p-interface: + object + + + +

+
+
+
+

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)
    • +
  • FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
    • +
  • FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
    • +
  • P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
    • +
  • P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ +
+ +
+
+
+ interface-name: + string + + + +
+
+

Name that identifies the physical interface

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ port-description: + string + + +
+
+

Nature of the services and connectivity on this port.

+
+ +
+
+
+ equipment-identifier: + string + + +
+
+

CLEI or other specification for p-interface hardware.

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role specification for p-interface hardware.

+
+ +
+
+
+ interface-type: + string + + +
+
+

Indicates the physical properties of the interface.

+
+ +
+
+
+ prov-status: + string + + +
+
+

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

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ inv-status: + string + + +
+
+

inventory status

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ sriov-pfs: + object[] + + +
+
+ +
+ +
+ sriov-pf + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

p-interfaces: + object + + + +

+
+
+
+

Collection of physical interfaces.

+ +
+ +
+
+
+ p-interface: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+
+
+
+ + +
+
+

platform: + object + + + +

+
+
+
+

describes a platform

+ +
    +
  • TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ +
+ +
+
+
+ platform-name: + string + + + +
+
+

Name of the platform

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

platforms: + object + + + +

+
+
+
+

Collection of platforms

+ +
+ +
+
+
+ platform: + object[] + + +
+
+ +
+ +
+ platform + + + +
+ +
+
+
+
+
+
+
+
+
+

pnf: + object + + + +

+
+
+
+

PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.

+ +
    +
  • TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
    • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
    • +
  • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ +
+ +
+
+
+ pnf-name: + string + + + +
+
+

unique name of Physical Network Function.

+
+ +
+
+
+ pnf-name2: + string + + +
+
+

name of Physical Network Function.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details.

+
+ +
+
+
+ pnf-name2-source: + string + + +
+
+

source of name2

+
+ +
+
+
+ pnf-id: + string + + +
+
+

id of pnf

+
+ +
+
+
+ equip-type: + string + + +
+
+

Equipment type. Source of truth should define valid values.

+
+ +
+
+
+ equip-vendor: + string + + +
+
+

Equipment vendor. Source of truth should define valid values.

+
+ +
+
+
+ equip-model: + string + + +
+
+

Equipment model. Source of truth should define valid values.

+
+ +
+
+
+ management-option: + string + + +
+
+

identifier of managed by ATT or customer

+
+ +
+
+
+ ipaddress-v4-oam: + string + + +
+
+

ipv4-oam-address with new naming convention for IP addresses

+
+ +
+
+
+ sw-version: + string + + +
+
+

sw-version is the version of SW for the hosted application on the PNF.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ frame-id: + string + + +
+
+

ID of the physical frame (relay rack) where pnf is installed.

+
+ +
+
+
+ serial-number: + string + + +
+
+

Serial number of the device

+
+ +
+
+
+ ipaddress-v4-loopback-0: + string + + +
+
+

IPV4 Loopback 0 address

+
+ +
+
+
+ ipaddress-v6-loopback-0: + string + + +
+
+

IPV6 Loopback 0 address

+
+ +
+
+
+ ipaddress-v4-aim: + string + + +
+
+

IPV4 AIM address

+
+ +
+
+
+ ipaddress-v6-aim: + string + + +
+
+

IPV6 AIM address

+
+ +
+
+
+ ipaddress-v6-oam: + string + + +
+
+

IPV6 OAM address

+
+ +
+
+
+ inv-status: + string + + +
+
+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

+
+ +
+
+
+ nf-role: + string + + +
+
+

Nf Role is the role performed by this instance in the network.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

pnfs: + object + + + +

+
+
+
+

Collection of Physical Network Functions.

+ +
+ +
+
+
+ pnf: + object[] + + +
+
+ +
+ +
+ pnf + + + +
+ +
+
+
+
+
+
+
+
+
+

port-group: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ interface-id: + string + + + +
+
+

Unique ID of the interface

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of this Interface

+
+ +
+
+
+ neutron-network-name: + string + + +
+
+

Neutron network name of this Interface

+
+ +
+
+
+ interface-role: + string + + +
+
+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ port-group-id: + string + + +
+
+

Unique ID for port group in vmware

+
+ +
+
+
+ port-group-name: + string + + +
+
+

Likely to duplicate value of neutron network name

+
+ +
+
+
+ switch-name: + string + + +
+
+

DVS or standard switch name (should be non-null for port groups associated with DVS)

+
+ +
+
+
+ orchestration-status: + string + + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ cvlan-tags: + object[] + + +
+
+ +
+ +
+ cvlan-tag-entry + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

port-groups: + object + + + +

+
+
+ +
+
+
+ port-group: + object[] + + +
+
+ +
+ +
+ port-group + + + +
+ +
+
+
+
+
+
+
+
+
+

project: + object + + + +

+
+
+
+

describes the project

+ +
    +
  • TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ +
+ +
+
+
+ project-name: + string + + + +
+
+

Name of the project deploying a service

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

projects: + object + + + +

+
+
+
+

Collection of projects

+ +
+ +
+
+
+ project: + object[] + + +
+
+ +
+ +
+ project + + + +
+ +
+
+
+
+
+
+
+
+
+

properties: + object + + + +

+
+
+
+

Property holder for query properties or instance properties

+ +
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

property-constraint: + object + + + +

+
+
+
+

TBD

+ +
    +
  • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ +
+ +
+
+
+ property-constraint-uuid: + string + + + +
+
+
+ +
+
+
+ constraint-type: + string + + + +
+
+
+ +
+
+
+ property-name: + string + + + +
+
+
+ +
+
+
+ property-value: + string + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

property-constraints: + object + + + +

+
+
+ +
+
+
+ property-constraint: + object[] + + +
+
+ +
+ +
+ property-constraint + + + +
+ +
+
+
+
+
+
+
+
+
+

pserver: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ hostname: + string + + + +
+
+

Value from executing hostname on the compute node.

+
+ +
+
+
+ ptnii-equip-name: + string + + +
+
+

PTNII name

+
+ +
+
+
+ number-of-cpus: + integer + + +
+
+

Number of cpus

+
+ +
+
+
+ disk-in-gigabytes: + integer + + +
+
+

Disk size, in GBs

+
+ +
+
+
+ ram-in-megabytes: + integer + + +
+
+

RAM size, in MBs

+
+ +
+
+
+ equip-type: + string + + +
+
+

Equipment type. Source of truth should define valid values.

+
+ +
+
+
+ equip-vendor: + string + + +
+
+

Equipment vendor. Source of truth should define valid values.

+
+ +
+
+
+ equip-model: + string + + +
+
+

Equipment model. Source of truth should define valid values.

+
+ +
+
+
+ fqdn: + string + + +
+
+

Fully-qualified domain name

+
+ +
+
+
+ pserver-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Used to configure device, also used for troubleshooting and is IP used for traps generated by device.

+
+ +
+
+
+ serial-number: + string + + +
+
+

Serial number, may be queried

+
+ +
+
+
+ ipaddress-v4-loopback-0: + string + + +
+
+

IPV4 Loopback 0 address

+
+ +
+
+
+ ipaddress-v6-loopback-0: + string + + +
+
+

IPV6 Loopback 0 address

+
+ +
+
+
+ ipaddress-v4-aim: + string + + +
+
+

IPV4 AIM address

+
+ +
+
+
+ ipaddress-v6-aim: + string + + +
+
+

IPV6 AIM address

+
+ +
+
+
+ ipaddress-v6-oam: + string + + +
+
+

IPV6 OAM address

+
+ +
+
+
+ inv-status: + string + + +
+
+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+
+ +
+
+
+ pserver-id: + string + + +
+
+

ID of Pserver

+
+ +
+
+
+ internet-topology: + string + + +
+
+

internet topology of Pserver

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ pserver-name2: + string + + +
+
+

alternative pserver name

+
+ +
+
+
+ purpose: + string + + +
+
+

purpose of pserver

+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

+
+ +
+
+
+ management-option: + string + + +
+
+

Indicates who owns and or manages the device.

+
+ +
+
+
+ host-profile: + string + + +
+
+

The host profile that defines the configuration of the pserver.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

pservers: + object + + + +

+
+
+
+

Collection of compute hosts.

+ +
+ +
+
+
+ pserver: + object[] + + +
+
+ +
+ +
+ pserver + + + +
+ +
+
+
+
+
+
+
+
+
+

query-parameters: + object + + + +

+
+
+
+

QueryParameters for performing a named-query or model query

+ +
+ +
+
+
+ named-query: + object + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+ overloaded-model: + object + + +
+
+ +
+ +
+ overloaded-model + + + +
+ +
+
+
+
+
+
+
+ + + +
+
+

relationship: + object + + + +

+
+
+ +
+
+
+ related-to: + string + + +
+
+

A keyword provided by A&AI to indicate type of node.

+
+ +
+
+
+ relationship-label: + string + + +
+
+

The edge label for this relationship.

+
+ +
+
+
+ related-link: + string + + +
+
+

URL to the object in A&AI.

+
+ +
+
+
+ relationship-data: + object[] + + +
+
+ +
+ +
+ relationship-data + + + +
+ +
+
+
+
+
+
+
+
+
+

relationship-data: + object + + + +

+
+
+ +
+
+
+ relationship-key: + string + + + +
+
+

A keyword provided by A&AI to indicate an attribute.

+
+ +
+
+
+ relationship-value: + string + + + +
+
+

Value of the attribute.

+
+ +
+
+
+
+
+
+
+
+

relationship-list: + object + + + +

+
+
+ +
+
+
+ relationship: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

reserved-prop-names: + object + + + +

+
+
+
+

Internal map to define some reserved properties of a vertex

+ +
+ +
+
+
+ last-mod-source-of-truth: + string + + +
+
+
+ +
+
+
+ aai-node-type: + string + + +
+
+
+ +
+
+
+ aai-created-ts: + integer + + +
+
+
+ +
+
+
+ aai-unique-key: + string + + +
+
+
+ +
+
+
+ aai-last-mod-ts: + integer + + +
+
+
+ +
+
+
+ source-of-truth: + string + + +
+
+
+ +
+
+
+ aai-uri: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

response-list: + object + + + +

+
+
+
+

Response container for the results of a named-query or model query

+ +
+ +
+
+
+ inventory-response-items: + object + + +
+
+ +
+ +
+ inventory-response-items + + + +
+ +
+
+
+
+
+
+
+
+
+

result-data: + object + + + +

+
+
+ +
+
+
+ resource-type: + string + + +
+
+

The specific type of node in the A&AI graph

+
+ +
+
+
+ resource-link: + string + + +
+
+

The URL to the specific resource

+
+ +
+
+
+
+
+
+
+
+

route-table-reference: + object + + + +

+
+
+
+

Openstack route table reference.

+ +
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ +
+ +
+
+
+ route-table-reference-id: + string + + + +
+
+

Route Table Reference id, UUID assigned to this instance.

+
+ +
+
+
+ route-table-reference-fqdn: + string + + + +
+
+

FQDN entry in the route table.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

route-table-references: + object + + + +

+
+
+
+

Collection of openstack route table references

+ +
+ +
+
+
+ route-table-reference: + object[] + + +
+
+ +
+ +
+ route-table-reference + + + +
+ +
+
+
+
+
+
+
+
+
+

route-target: + object + + + +

+
+
+
+

Route target information

+ +
    +
  • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ +
+ +
+
+
+ global-route-target: + string + + + +
+
+

Number used to identify an RT, globally unique in the network

+
+ +
+
+
+ route-target-role: + string + + + +
+
+

Role assigned to this route target

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

route-targets: + object + + + +

+
+
+
+

Collection of route target information

+ +
+ +
+
+
+ route-target: + object[] + + +
+
+ +
+ +
+ route-target + + + +
+ +
+
+
+
+
+
+
+
+
+

routing-instance: + object + + + +

+
+
+
+ +
    +
  • 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
+ +
+ +
+
+
+ routing-instance-id: + string + + + +
+
+

Unique id of routing instance

+
+ +
+
+
+ rpm-owner: + string + + +
+
+

rpm owner

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ site-pairs: + object[] + + +
+
+ +
+ +
+ site-pair + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

routing-instances: + object + + + +

+
+
+
+

set of probes related to generic-vnf routing instance

+ +
+ +
+
+
+ routing-instance: + object[] + + +
+
+ +
+ +
+ routing-instance + + + +
+ +
+
+
+
+
+
+
+
+
+

sdn-zone-response: + object + + + +

+
+
+ +
+
+
+ oam-networks: + object + + +
+
+ +
+ +
+ oam-networks + + + +
+ +
+
+
+
+ az-and-dvs-switches: + object[] + + +
+
+ +
+ +
+ az-and-dvs-switches + + + +
+ +
+
+
+
+
+
+
+ +
+
+

search-results: + object + + + +

+
+
+ +
+
+
+ result-data: + object[] + + +
+
+ +
+ +
+ result-data + + + +
+ +
+
+
+
+
+
+
+
+
+

secondary-filt: + object + + + +

+
+
+
+

SecondaryFilt for performing a named-query or model query

+ +
+ +
+
+
+
+
+
+
+
+

secondary-filter: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ filter-type: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

secondary-filts: + object + + + +

+
+
+
+

SecondaryFilts for performing a named-query or model query

+ +
+ +
+
+
+ secondary-filt: + object[] + + +
+
+ +
+ +
+ secondary-filt + + + +
+ +
+
+
+
+
+
+
+
+
+

segmentation-assignment: + object + + + +

+
+
+
+

Openstack segmentation assignment.

+ +
    +
  • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ +
+ +
+
+
+ segmentation-id: + string + + + +
+
+

Route Table Reference id, UUID assigned to this instance.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

segmentation-assignments: + object + + + +

+
+
+
+

Collection of openstack segmentation assignments

+ +
+ +
+
+
+ segmentation-assignment: + object[] + + +
+
+ +
+ +
+ segmentation-assignment + + + +
+ +
+
+
+
+
+
+
+
+
+

service: + object + + + +

+
+
+
+

Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

+ +
+ +
+
+
+ service-id: + string + + + +
+
+

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
+ +
+
+
+ service-description: + string + + + +
+
+

Description of the service

+
+ +
+
+
+ service-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-version: + string + + +
+
+

service version

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-capabilities: + object + + + +

+
+
+
+

Collection of service capabilities.

+ +
+ +
+
+
+ service-capability: + object[] + + +
+
+ +
+ +
+ service-capability + + + +
+ +
+
+
+
+
+
+
+
+
+

service-capability: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ service-type: + string + + + +
+
+

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-design-and-creation: + object + + + +

+
+
+
+

Namespace for objects managed by ASDC

+ +
+ +
+
+
+ vnf-images: + object[] + + +
+
+ +
+ +
+ vnf-image + + + +
+ +
+
+
+
+ services: + object[] + + +
+
+ +
+ +
+ service + + + +
+ +
+
+
+
+ service-capabilities: + object[] + + +
+
+ +
+ +
+ service-capability + + + +
+ +
+
+
+
+ models: + object[] + + +
+
+ +
+ +
+ model + + + +
+ +
+
+
+
+ named-queries: + object[] + + +
+
+ +
+ +
+ named-query + + + +
+ +
+
+
+
+
+
+
+
+
+

service-instance: + object + + + +

+
+
+
+

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 owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
    • +
  • TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • +
  • TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    • +
  • TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
    • +
  • TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • +
  • TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • +
  • TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • +
  • TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
    • +
  • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ +
+ +
+
+
+ service-instance-id: + string + + + +
+
+

Uniquely identifies this instance of a service

+
+ +
+
+
+ service-instance-name: + string + + +
+
+

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

+
+ +
+
+
+ service-type: + string + + + +
+
+

String capturing type of service.

+
+ +
+
+
+ service-role: + string + + + +
+
+

String capturing the service role.

+
+ +
+
+
+ environment-context: + string + + +
+
+

This field will store the environment context assigned to the service-instance.

+
+ +
+
+
+ workload-context: + string + + +
+
+

This field will store the workload context assigned to the service-instance.

+
+ +
+
+
+ created-at: + string + + + +
+
+

create time of Network Service.

+
+ +
+
+
+ updated-at: + string + + + +
+
+

last update of Network Service.

+
+ +
+
+
+ description: + string + + + +
+
+

short description for service-instance.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

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

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

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

+
+ +
+
+
+ bandwidth-total: + string + + +
+
+

Indicates the total bandwidth to be used for this service.

+
+ +
+
+
+ bandwidth-up-wan1: + string + + +
+
+

indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.

+
+ +
+
+
+ bandwidth-down-wan1: + string + + +
+
+

indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.

+
+ +
+
+
+ bandwidth-up-wan2: + string + + +
+
+

indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.

+
+ +
+
+
+ bandwidth-down-wan2: + string + + +
+
+

indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.

+
+ +
+
+
+ vhn-portal-url: + string + + +
+
+

URL customers will use to access the vHN Portal.

+
+ +
+
+
+ service-instance-location-id: + string + + +
+
+

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

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this service.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ metadata: + object[] + + +
+
+ +
+ +
+ metadatum + + + +
+ +
+
+
+
+ allotted-resources: + object[] + + +
+
+ +
+ +
+ allotted-resource + + + +
+ +
+
+
+
+
+
+
+
+
+

service-instances: + object + + + +

+
+
+
+

Collection of service instances

+ +
+ +
+
+
+ service-instance: + object[] + + +
+
+ +
+ +
+ service-instance + + + +
+ +
+
+
+
+
+
+
+
+
+

service-subscription: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ service-type: + string + + + +
+
+

Value defined by orchestration to identify this service across ECOMP.

+
+ +
+
+
+ temp-ub-sub-account-id: + string + + +
+
+

This property will be deleted from A&AI in the near future. Only stop gap solution.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ service-instances: + object[] + + +
+
+ +
+ +
+ service-instance + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

service-subscriptions: + object + + + +

+
+
+
+

Collection of objects that group service instances.

+ +
+ +
+
+
+ service-subscription: + object[] + + +
+
+ +
+ +
+ service-subscription + + + +
+ +
+
+
+
+
+
+
+
+
+

services: + object + + + +

+
+
+
+

Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.

+ +
+ +
+
+
+ service: + object[] + + +
+
+ +
+ +
+ service + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair: + object + + + +

+
+
+
+ +
    +
  • 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
+ +
+ +
+
+
+ site-pair-id: + string + + + +
+
+

unique identifier of probe

+
+ +
+
+
+ source-ip: + string + + +
+
+

Prefix address

+
+ +
+
+
+ destination-ip: + string + + +
+
+

Prefix address

+
+ +
+
+
+ ip-version: + string + + +
+
+

ip version, v4, v6

+
+ +
+
+
+ destination-hostname: + string + + +
+
+

Hostname of the destination equipment to which SLAs are measured against.

+
+ +
+
+
+ destination-equip-type: + string + + +
+
+

The type of destinatination equipment. Could be Router, UCPE, etc.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ classes-of-service: + object[] + + +
+
+ +
+ +
+ class-of-service + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair-set: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ site-pair-set-id: + string + + + +
+
+

Unique id of site pair set.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ routing-instances: + object[] + + +
+
+ +
+ +
+ routing-instance + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pair-sets: + object + + + +

+
+
+
+

Collection of sets of instances for probes related to generic-vnf

+ +
+ +
+
+
+ site-pair-set: + object[] + + +
+
+ +
+ +
+ site-pair-set + + + +
+ +
+
+
+
+
+
+
+
+
+

site-pairs: + object + + + +

+
+
+
+

probe within a set

+ +
+ +
+
+
+ site-pair: + object[] + + +
+
+ +
+ +
+ site-pair + + + +
+ +
+
+
+
+
+
+
+
+
+

snapshot: + object + + + +

+
+
+
+

Openstack snapshot

+ +
    +
  • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ +
+ +
+
+
+ snapshot-id: + string + + + +
+
+

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+
+ +
+
+
+ snapshot-name: + string + + +
+
+

Snapshot name

+
+ +
+
+
+ snapshot-architecture: + string + + +
+
+

Operating system architecture

+
+ +
+
+
+ snapshot-os-distro: + string + + +
+
+

The common name of the operating system distribution in lowercase

+
+ +
+
+
+ snapshot-os-version: + string + + +
+
+

The operating system version as specified by the distributor.

+
+ +
+
+
+ application: + string + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ snapshot-selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ prev-snapshot-id: + string + + +
+
+

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

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

snapshots: + object + + + +

+
+
+
+

Collection of openstack snapshots

+ +
+ +
+
+
+ snapshot: + object[] + + +
+
+ +
+ +
+ snapshot + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-pf: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ pf-pci-id: + string + + + +
+
+

Identifier for the sriov-pf

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-pfs: + object + + + +

+
+
+
+

Collection of SR-IOV Physical Functions.

+ +
+ +
+
+
+ sriov-pf: + object[] + + +
+
+ +
+ +
+ sriov-pf + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-vf: + object + + + +

+
+
+
+

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 sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ +
+ +
+
+
+ pci-id: + string + + + +
+
+

PCI ID used to identify the sriov-vf

+
+ +
+
+
+ vf-vlan-filter: + string + + +
+
+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+
+ +
+
+
+ vf-mac-filter: + string + + +
+
+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+
+ +
+
+
+ vf-vlan-strip: + boolean + + +
+
+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+
+ +
+
+
+ vf-vlan-anti-spoof-check: + boolean + + +
+
+

This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

+
+ +
+
+
+ vf-mac-anti-spoof-check: + boolean + + +
+
+

This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

+
+ +
+
+
+ vf-mirrors: + string + + +
+
+

This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.

+
+ +
+
+
+ vf-broadcast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM

+
+ +
+
+
+ vf-unknown-multicast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM

+
+ +
+
+
+ vf-unknown-unicast-allow: + boolean + + +
+
+

This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM

+
+ +
+
+
+ vf-insert-stag: + boolean + + +
+
+

This option, if set to true, instructs to insert outer tag after traffic comes out of VM.

+
+ +
+
+
+ vf-link-status: + string + + +
+
+

This option is used to set the link status. Valid values as of 1607 are on, off, and auto.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

sriov-vfs: + object + + + +

+
+
+
+

Collection of SR-IOV Virtual Functions.

+ +
+ +
+
+
+ sriov-vf: + object[] + + +
+
+ +
+ +
+ sriov-vf + + + +
+ +
+
+
+
+
+
+
+
+
+

start-node-filter: + object + + + +

+
+
+ +
+
+
+ property-name: + string + + +
+
+
+ +
+
+
+ property-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

subnet: + object + + + +

+
+
+
+ +
    +
  • TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
    • +
  • SUBNET is DELETED when these are DELETED HOST-ROUTE
+ +
+ +
+
+
+ subnet-id: + string + + + +
+
+

Subnet ID, should be UUID.

+
+ +
+
+
+ subnet-name: + string + + +
+
+

Name associated with the subnet.

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of this subnet

+
+ +
+
+
+ gateway-address: + string + + +
+
+

gateway ip address

+
+ +
+
+
+ network-start-address: + string + + +
+
+

network start address

+
+ +
+
+
+ cidr-mask: + string + + +
+
+

cidr mask

+
+ +
+
+
+ ip-version: + string + + +
+
+

ip version

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ dhcp-enabled: + boolean + + + +
+
+
+ +
+
+
+ dhcp-start: + string + + +
+
+

the start address reserved for use by dhcp

+
+ +
+
+
+ dhcp-end: + string + + +
+
+

the last address reserved for use by dhcp

+
+ +
+
+
+ subnet-role: + string + + +
+
+

role of the subnet, referenced when assigning IPs

+
+ +
+
+
+ ip-assignment-direction: + string + + +
+
+

ip address assignment direction of the subnet

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ subnet-sequence: + integer + + +
+
+

sequence of the subnet

+
+ +
+
+
+ host-routes: + object[] + + +
+
+ +
+ +
+ host-route + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

subnets: + object + + + +

+
+
+ +
+
+
+ subnet: + object[] + + +
+
+ +
+ +
+ subnet + + + +
+ +
+
+
+
+
+
+
+
+
+

tagged-inventory-item-list: + object + + + +

+
+
+ +
+
+
+ inventory-item: + object[] + + +
+
+ +
+ +
+ inventory-item + + + +
+ +
+
+
+
+
+
+
+
+
+

tenant: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ tenant-id: + string + + + +
+
+

Unique id relative to the cloud-region.

+
+ +
+
+
+ tenant-name: + string + + + +
+
+

Readable name of tenant

+
+ +
+
+
+ tenant-context: + string + + +
+
+

This field will store the tenant context.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ vservers: + object[] + + +
+
+ +
+ +
+ vserver + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

tenants: + object + + + +

+
+
+
+

Collection of openstack tenants.

+ +
+ +
+
+
+ tenant: + object[] + + +
+
+ +
+ +
+ tenant + + + +
+ +
+
+
+
+
+
+
+
+
+

tunnel-xconnect: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ id: + string + + + +
+
+

Allotted Resource id UUID assigned to this instance.

+
+ +
+
+
+ bandwidth-up-wan1: + string + + +
+
+

The WAN uplink bandwidth for WAN1

+
+ +
+
+
+ bandwidth-down-wan1: + string + + +
+
+

The WAN downlink bandwidth for WAN1

+
+ +
+
+
+ bandwidth-up-wan2: + string + + +
+
+

The WAN uplink bandwidth for WAN2

+
+ +
+
+
+ bandwidth-down-wan2: + string + + +
+
+

The WAN downlink bandwidth for WAN2

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

tunnel-xconnects: + object + + + +

+
+
+
+

This object is used to store the specific tunnel cross connect aspects of an allotted resource

+ +
+ +
+
+
+ tunnel-xconnect: + object[] + + +
+
+ +
+ +
+ tunnel-xconnect + + + +
+ +
+
+
+
+
+
+
+
+
+

update: + object + + + +

+
+
+
+

Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.

+ +
+ +
+
+
+ update-node-type: + string + + + +
+
+
+ +
+
+
+ update-node-uri: + string + + +
+
+
+ +
+
+
+ update-node-key: + object[] + + +
+
+ +
+ +
+ update-node-key + + + +
+ +
+
+
+
+ action: + object[] + + +
+
+ +
+ +
+ action + + + +
+ +
+
+
+
+
+
+
+
+
+

update-node-key: + object + + + +

+
+
+ +
+
+
+ key-name: + string + + +
+
+
+ +
+
+
+ key-value: + string + + +
+
+
+ +
+
+
+
+
+
+
+
+

vce: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+ vnf-name: + string + + + +
+
+

Name of VNF.

+
+ +
+
+
+ vnf-name2: + string + + +
+
+

Alternate name of VNF.

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ service-id: + string + + +
+
+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+
+ +
+
+
+ regional-resource-zone: + string + + +
+
+

Regional way of organizing pservers, source of truth should define values

+
+ +
+
+
+ prov-status: + string + + +
+
+

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

+
+ +
+
+
+ operational-status: + string + + +
+
+

Indicator for whether the resource is considered operational

+
+ +
+
+
+ license-key: + string + + +
+
+

OBSOLETE - do not use

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Network role being played by this VNF

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by MSO

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance, managed by MSO

+
+ +
+
+
+ mso-catalog-key: + string + + +
+
+

Corresponds to the SDN-C catalog id used to configure this VCE

+
+ +
+
+
+ vpe-id: + string + + +
+
+

Unique ID of VPE connected to this VCE.

+
+ +
+
+
+ v6-vce-wan-address: + string + + +
+
+

Valid v6 IP address for the WAN Link on this router. Implied length of /64.

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ ipv4-loopback0-address: + string + + +
+
+

Loopback0 address

+
+ +
+
+
+ entitlement-resource-uuid: + string + + +
+
+

OBSOLETE - see child relationships

+
+ +
+
+
+ port-groups: + object[] + + +
+
+ +
+ +
+ port-group + + + +
+ +
+
+
+
+ licenses: + object[] + + +
+
+ +
+ +
+ license + + + +
+ +
+
+
+
+ entitlements: + object[] + + +
+
+ +
+ +
+ entitlement + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vces: + object + + + +

+
+
+
+

Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.

+ +
+ +
+
+
+ vce: + object[] + + +
+
+ +
+ +
+ vce + + + +
+ +
+
+
+
+
+
+
+
+
+

vf-module: + object + + + +

+
+
+
+

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)
    • +
  • TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
    • +
  • VF-MODULE cannot be deleted if linked to VNFC
+ +
+ +
+
+
+ vf-module-id: + string + + + +
+
+

Unique ID of vf-module.

+
+ +
+
+
+ vf-module-name: + string + + +
+
+

Name of vf-module

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this instance.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

orchestration status of this vf-module, mastered by MSO

+
+ +
+
+
+ is-base-vf-module: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ persona-model-version: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ widget-model-id: + string + + +
+
+

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

+
+ +
+
+
+ widget-model-version: + string + + +
+
+

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

+
+ +
+
+
+ contrail-service-instance-fqdn: + string + + +
+
+

the Contrail unique ID for a service-instance

+
+ +
+
+
+ module-index: + integer + + +
+
+

the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit

+
+ +
+
+
+ selflink: + string + + +
+
+

Path to the controller object.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vf-modules: + object + + + +

+
+
+
+

Collection of vf-modules, a deployment unit of VNFCs

+ +
+ +
+
+
+ vf-module: + object[] + + +
+
+ +
+ +
+ vf-module + + + +
+ +
+
+
+
+
+
+
+
+
+

vig-server: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ vig-address-type: + string + + + +
+
+

indicates whether the VIG is for AVPN or INTERNET

+
+ +
+
+
+ ipaddress-v4-vig: + string + + +
+
+

v4 IP of the vig server

+
+ +
+
+
+ ipaddress-v6-vig: + string + + +
+
+

v6 IP of the vig server

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vig-servers: + object + + + +

+
+
+ +
+
+
+ vig-server: + object[] + + +
+
+ +
+ +
+ vig-server + + + +
+ +
+
+
+
+
+
+
+
+
+

vip-ipv4-address-list: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ vip-ipv4-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ vip-ipv4-prefix-length: + integer + + +
+
+

Prefix length, 32 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vip-ipv6-address-list: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ vip-ipv6-address: + string + + + +
+
+

IP address

+
+ +
+
+
+ vip-ipv6-prefix-length: + integer + + +
+
+

Prefix length, 128 for single address

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ is-floating: + boolean + + +
+
+

Indicator of fixed or floating address

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ neutron-network-id: + string + + +
+
+

Neutron network id of the interface that address belongs to

+
+ +
+
+
+ neutron-subnet-id: + string + + +
+
+

Neutron id of subnet that address belongs to

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

virtual-data-center: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ vdc-id: + string + + + +
+
+

Unique ID of the vdc

+
+ +
+
+
+ vdc-name: + string + + + +
+
+

Name of the virtual data center

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

virtual-data-centers: + object + + + +

+
+
+
+

Virtual organization of cloud infrastructure elements in a data center context

+ +
+ +
+
+
+ virtual-data-center: + object[] + + +
+
+ +
+ +
+ virtual-data-center + + + +
+ +
+
+
+
+
+
+
+
+
+

vlan: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vlan-interface: + string + + + +
+
+

String that identifies the interface

+
+ +
+
+
+ vlan-id-inner: + integer + + +
+
+

Inner VLAN tag

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Outer VLAN tag

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ speed-value: + string + + +
+
+

Captures the numeric part of the speed

+
+ +
+
+
+ speed-units: + string + + +
+
+

Captures the units corresponding to the speed

+
+ +
+
+
+ vlan-description: + string + + +
+
+

Used to describe (the service associated with) the vlan

+
+ +
+
+
+ backdoor-connection: + string + + +
+
+

Whether customer is going to use this VLAN for backdoor connection to another customer premise device.

+
+ +
+
+
+ vpn-key: + string + + +
+
+

This indicates the customers VPN ID associated with this vlan

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

+
+ +
+
+
+ is-ip-unnumbered: + boolean + + + +
+
+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

vlans: + object + + + +

+
+
+ +
+
+
+ vlan: + object[] + + +
+
+ +
+ +
+ vlan + + + +
+ +
+
+
+
+
+
+
+
+
+

vnf: + object + + + +

+
+
+
+

Abstract vnf class

+ +
+ +
+
+
+ vnf-id: + string + + + +
+
+

Unique id of VNF. This is unique across the graph.

+
+ +
+
+
+
+
+
+
+
+

vnf-image: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vnf-image-uuid: + string + + + +
+
+

Unique ID of this asset

+
+ +
+
+
+ application: + string + + + +
+
+

The application that the image instantiates.

+
+ +
+
+
+ application-vendor: + string + + + +
+
+

The vendor of the application.

+
+ +
+
+
+ application-version: + string + + +
+
+

The version of the application.

+
+ +
+
+
+ selflink: + string + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vnf-images: + object + + + +

+
+
+
+

Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.

+ +
+ +
+
+
+ vnf-image: + object[] + + +
+
+ +
+ +
+ vnf-image + + + +
+ +
+
+
+
+
+
+
+
+
+

vnfc: + object + + + +

+
+
+
+ +
    +
  • TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
    • +
  • TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
    • +
  • TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • +
  • VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ +
+ +
+
+
+ vnfc-name: + string + + + +
+
+

Unique ID of vnfc.

+
+ +
+
+
+ nfc-naming-code: + string + + + +
+
+

Short code that is used in naming instances of the item being modeled

+
+ +
+
+
+ nfc-function: + string + + + +
+
+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+
+ +
+
+
+ prov-status: + string + + +
+
+

prov status of this vnfc

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this VNF, mastered by APP-C

+
+ +
+
+
+ ipaddress-v4-oam-vip: + string + + +
+
+

Oam V4 vip address of this vnfc

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ group-notation: + string + + +
+
+

Group notation of VNFC

+
+ +
+
+
+ model-invariant-id: + string + + +
+
+

the ASDC model id for this resource or service model.

+
+ +
+
+
+ model-version-id: + string + + +
+
+

the ASDC model version for this resource or service model.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l3-interface-ipv4-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv4-address-list + + + +
+ +
+
+
+
+ l3-interface-ipv6-address-list: + object[] + + +
+
+ +
+ +
+ l3-interface-ipv6-address-list + + + +
+ +
+
+
+
+
+
+
+
+
+

vnfcs: + object + + + +

+
+
+
+

virtual network components associated with a vserver from application controller.

+ +
+ +
+
+
+ vnfc: + object[] + + +
+
+ +
+ +
+ vnfc + + + +
+ +
+
+
+
+
+
+
+
+
+

volume: + object + + + +

+
+
+
+

Ephemeral Block storage volume.

+ +
    +
  • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ +
+ +
+
+
+ volume-id: + string + + + +
+
+

Unique ID of block storage volume relative to the vserver.

+
+ +
+
+
+ volume-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

volume-group: + object + + + +

+
+
+
+

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)
+ +
+ +
+
+
+ volume-group-id: + string + + + +
+
+

Unique ID of volume-group.

+
+ +
+
+
+ volume-group-name: + string + + + +
+
+

Name of the volume group.

+
+ +
+
+
+ heat-stack-id: + string + + +
+
+

Heat stack id corresponding to this volume-group

+
+ +
+
+
+ vnf-type: + string + + + +
+
+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+
+ +
+
+
+ orchestration-status: + string + + +
+
+

Orchestration status of this volume-group

+
+ +
+
+
+ model-customization-id: + string + + +
+
+

captures the id of all the configuration used to customize the resource for the service.

+
+ +
+
+
+ vf-module-model-customization-id: + string + + +
+
+

helps relate the volume group to the vf-module whose components will require the volume group

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

volume-groups: + object + + + +

+
+
+
+

Collection of persistent block-level storage.

+ +
+ +
+
+
+ volume-group: + object[] + + +
+
+ +
+ +
+ volume-group + + + +
+ +
+
+
+
+
+
+
+
+
+

volumes: + object + + + +

+
+
+
+

Collection of ephemeral Block storage volumes.

+ +
+ +
+
+
+ volume: + object[] + + +
+
+ +
+ +
+ volume + + + +
+ +
+
+
+
+
+
+
+
+
+

vpls-pe: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ equipment-name: + string + + + +
+
+
+ +
+
+
+ prov-status: + string + + +
+
+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+
+ +
+
+
+ ipv4-oam-address: + string + + +
+
+

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

+
+ +
+
+
+ equipment-role: + string + + +
+
+

Client should send valid enumerated value, e.g., VPLS-PE.

+
+ +
+
+
+ vlan-id-outer: + integer + + +
+
+

Temporary location for stag to get to VCE

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ p-interfaces: + object[] + + +
+
+ +
+ +
+ p-interface + + + +
+ +
+
+
+
+ lag-interfaces: + object[] + + +
+
+ +
+ +
+ lag-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

vpls-pes: + object + + + +

+
+
+
+

Collection of VPLS Provider Edge routers

+ +
+ +
+
+
+ vpls-pe: + object[] + + +
+
+ +
+ +
+ vpls-pe + + + +
+ +
+
+
+
+
+
+
+
+
+

vpn-binding: + object + + + +

+
+
+
+

VPN binding

+ +
    +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
    • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • +
  • VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
    • +
  • VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ +
+ +
+
+
+ vpn-id: + string + + + +
+
+

VPN ID, globally unique within A&AI

+
+ +
+
+
+ vpn-name: + string + + + +
+
+

VPN Name

+
+ +
+
+
+ vpn-platform: + string + + +
+
+

the platform associated with the VPN example AVPN, Mobility

+
+ +
+
+
+ vpn-type: + string + + +
+
+

Type of the vpn, should be taken from enumerated/valid values

+
+ +
+
+
+ vpn-region: + string + + +
+
+

region of customer vpn

+
+ +
+
+
+ customer-vpn-id: + string + + +
+
+

id for this customer vpn

+
+ +
+
+
+ route-distinguisher: + string + + +
+
+

Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ route-targets: + object[] + + +
+
+ +
+ +
+ route-target + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

vpn-bindings: + object + + + +

+
+
+ +
+
+
+ vpn-binding: + object[] + + +
+
+ +
+ +
+ vpn-binding + + + +
+ +
+
+
+
+
+
+
+
+
+

vserver: + object + + + +

+
+
+
+

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
+ +
+ +
+
+
+ vserver-id: + string + + + +
+
+

Unique identifier for this vserver relative to its tenant

+
+ +
+
+
+ vserver-name: + string + + + +
+
+

Name of vserver

+
+ +
+
+
+ vserver-name2: + string + + +
+
+

Alternative name of vserver

+
+ +
+
+
+ prov-status: + string + + +
+
+

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

+
+ +
+
+
+ vserver-selflink: + string + + + +
+
+

URL to endpoint where AAI can get more details

+
+ +
+
+
+ in-maint: + boolean + + + +
+
+
+ +
+
+
+ is-closed-loop-disabled: + boolean + + + +
+
+
+ +
+
+
+ resource-version: + string + + +
+
+

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

+
+ +
+
+
+ volumes: + object[] + + +
+
+ +
+ +
+ volume + + + +
+ +
+
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+ l-interfaces: + object[] + + +
+
+ +
+ +
+ l-interface + + + +
+ +
+
+
+
+
+
+
+
+
+

vservers: + object + + + +

+
+
+
+

Collection of virtual Servers, aka virtual machines or VMs.

+ +
+ +
+
+
+ vserver: + object[] + + +
+
+ +
+ +
+ vserver + + + +
+ +
+
+
+
+
+
+
+
+
+

zone: + object + + + +

+
+
+
+

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)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ +
+ +
+
+
+ zone-id: + string + + + +
+
+

Code assigned by AIC to the zone

+
+ +
+
+
+ zone-name: + string + + + +
+
+

English name associated with the zone

+
+ +
+
+
+ design-type: + string + + + +
+
+

Design of zone [Medium/Largeā€¦]

+
+ +
+
+
+ zone-context: + string + + + +
+
+

Context of zone [production/test]

+
+ +
+
+
+ status: + string + + +
+
+

Status of a zone.

+
+ +
+
+
+ resource-version: + string + + +
+
+

Concurrency value

+
+ +
+
+
+ relationship-list: + object[] + + +
+
+ +
+ +
+ relationship + + + +
+ +
+
+
+
+
+
+
+
+
+

zones: + object + + + +

+
+
+
+

Collection of zones

+ +
+ +
+
+
+ zone: + object[] + + +
+
+ +
+ +
+ zone + + + +
+ +
+
+
+
+
+
+
+
+ + diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v8.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v8.html index d3bc2a6c..d4cfa0c8 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v8.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v8.html @@ -1,4 +1,3 @@ - @@ -15,7 +14,7 @@

Active and Available Inventory REST API.

-

Version: v10

+

Version: v12

Copyright © 2017 AT&T Intellectual Property. All rights reserved.

Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
@@ -3529,446 +3528,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

delete an existing relationship

- - - - GET /network/vpes -

returns vpes

- - - - GET /network/vpes/vpe/{vnf-id} -

returns vpe

- - - - PUT /network/vpes/vpe/{vnf-id} -

create or update an existing vpe

- - - - DELETE /network/vpes/vpe/{vnf-id} -

delete an existing vpe

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces -

returns l-interfaces

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name} -

returns l-interface

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name} -

create or update an existing l-interface

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name} -

delete an existing l-interface

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} -

returns l3-interface-ipv4-address-list

- - - - PUT /network/vpes/vpe/{vnf-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

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} -

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

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} -

returns l3-interface-ipv6-address-list

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} -

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

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} -

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

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs -

returns sriov-vfs

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

returns sriov-vf

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

create or update an existing sriov-vf

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

delete an existing sriov-vf

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans -

returns vlans

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

returns vlan

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

create or update an existing vlan

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

delete an existing vlan

- - - - GET /network/vpes/vpe/{vnf-id}/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

- - - - PUT /network/vpes/vpe/{vnf-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

- - - - DELETE /network/vpes/vpe/{vnf-id}/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

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} -

returns l3-interface-ipv6-address-list

- - - - PUT /network/vpes/vpe/{vnf-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 l3-interface-ipv6-address-list

- - - - DELETE /network/vpes/vpe/{vnf-id}/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

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces -

returns lag-interfaces

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name} -

returns lag-interface

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name} -

create or update an existing lag-interface

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name} -

delete an existing lag-interface

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces -

returns l-interfaces

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} -

returns l-interface

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} -

create or update an existing l-interface

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} -

delete an existing l-interface

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} -

returns l3-interface-ipv4-address-list

- - - - PUT /network/vpes/vpe/{vnf-id}/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 l3-interface-ipv4-address-list

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} -

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

- - - - PUT /network/vpes/vpe/{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 -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} -

returns l3-interface-ipv6-address-list

- - - - PUT /network/vpes/vpe/{vnf-id}/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-ipv6-address-list

- - - - DELETE /network/vpes/vpe/{vnf-id}/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-ipv6-address-list

- - - - PUT /network/vpes/vpe/{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 -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs -

returns sriov-vfs

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

returns sriov-vf

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

create or update an existing sriov-vf

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} -

delete an existing sriov-vf

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship -

delete an existing relationship

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans -

returns vlans

- - - - GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

returns vlan

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

create or update an existing vlan

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} -

delete an existing vlan

- - - - GET /network/vpes/vpe/{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} -

returns l3-interface-ipv4-address-list

- - - - PUT /network/vpes/vpe/{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} -

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

- - - - DELETE /network/vpes/vpe/{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 an existing l3-interface-ipv4-address-list

- - - - PUT /network/vpes/vpe/{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 -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{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 an existing relationship

- - - - GET /network/vpes/vpe/{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 l3-interface-ipv6-address-list

- - - - PUT /network/vpes/vpe/{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} -

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

- - - - DELETE /network/vpes/vpe/{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 l3-interface-ipv6-address-list

- - - - PUT /network/vpes/vpe/{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 -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship -

delete an existing relationship

- - - - PUT /network/vpes/vpe/{vnf-id}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /network/vpes/vpe/{vnf-id}/relationship-list/relationship -

delete an existing relationship

@@ -96695,17 +96254,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vpes
-

GET /network/vpes

+
returns vpls-pes
+

GET /network/vpls-pes

Tags: Network
-

returns vpes

+

returns vpls-pes

@@ -96731,7 +96290,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vpes + /vpls-pes
@@ -96759,17 +96318,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vpe
-

GET /network/vpes/vpe/{vnf-id}

+
returns vpls-pe
+

GET /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

returns vpe

+

returns vpls-pe

@@ -96786,10 +96345,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

path @@ -96800,102 +96358,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service from ASDC

- - 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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

query @@ -96931,7 +96399,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vpe + /vpls-pe
@@ -96959,17 +96427,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vpe
-

PUT /network/vpes/vpe/{vnf-id}

+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

create or update an existing vpe

+

create or update an existing vpls-pe

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

-

vpe object that needs to be created or updated

+

vpls-pe object that needs to be created or updated

- /vpe + /vpls-pe
@@ -97003,10 +96471,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

path @@ -97048,17 +96515,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vpe
-

DELETE /network/vpes/vpe/{vnf-id}

+
delete an existing vpls-pe
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

delete an existing vpe

+

delete an existing vpls-pe

@@ -97080,10 +96547,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

path @@ -97141,17 +96607,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interfaces
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces

+
returns lag-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Tags: Network
-

returns l-interfaces

+

returns lag-interfaces

@@ -97168,10 +96634,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

path @@ -97184,40 +96649,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 + prov-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + - + - + @@ -97262,22 +96777,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - -
- service-id + equipment-name -

Unique identifier of service from ASDC

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name that identifies the link aggregate interface

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -97313,7 +96813,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /lag-interface
@@ -97341,19 +96841,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
create or update an existing lag-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns l-interface

+

create or update an existing lag-interface

+
+ +

application/json application/xml +

+
+
+

lag-interface object that needs to be created or updated

+

+
+
+
+
+ /lag-interface +
+
+
+
@@ -97368,10 +96885,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -97387,7 +96903,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 @@ -97398,42 +96914,104 @@ 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 lag-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- vnf-name + equipment-name -

Name of VNF.

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name that identifies the link aggregate interface

querypath string +
- vnf-type + resource-version -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.

+

resource-version for concurrency

 query @@ -97441,36 +97019,94 @@ 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 l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+ Tags: + Network +
+
+
+

returns l-interfaces

+ +
+
+ + + + + + + + + + + - + - + @@ -97478,7 +97114,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status + +
- service-id + equipment-name -

Unique identifier of service from ASDC

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name that identifies the link aggregate interface

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -97488,12 +97124,138 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
+
+ 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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -97969,22 +97701,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -98767,22 +98484,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - - - - - - - - - - - - - -
+ equipment-name + + path + string + + + +
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

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 @@ -97602,11 +97364,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l-interface
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
@@ -97646,10 +97408,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

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

Name that identifies the link aggregate interface

 path @@ -97707,11 +97484,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l-interface
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
@@ -97739,10 +97516,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

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

Name that identifies the link aggregate interface

 path @@ -97816,11 +97608,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -97843,10 +97635,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -97862,7 +97653,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 @@ -97875,10 +97666,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name given to the interface

 path @@ -97891,77 +97682,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + l3-interface-ipv4-address -

Regional way of organizing pservers, source of truth should define values

+

IP address

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -98138,11 +97855,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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -98182,10 +97899,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

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

Name that identifies the link aggregate interface

 path @@ -98259,11 +97991,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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -98291,10 +98023,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

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

Name that identifies the link aggregate interface

 path @@ -98384,11 +98131,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

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
@@ -98428,10 +98175,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -98505,11 +98267,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
@@ -98537,10 +98299,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -98614,11 +98391,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -98641,10 +98418,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -98660,7 +98436,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 @@ -98673,10 +98449,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 @@ -98689,77 +98465,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + l3-interface-ipv6-address -

Regional way of organizing pservers, source of truth should define values

+

IP address

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -98936,11 +98638,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 /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -98980,10 +98682,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -98999,100 +98700,131 @@ 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 - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/vpes/vpe/{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.

+

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/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 +
+
+
+

delete an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -99747,22 +99479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -100024,22 +99681,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -100821,22 +100463,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -101098,22 +100665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -101667,22 +101189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -102575,22 +102082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -99182,11 +98914,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

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
@@ -99226,10 +98958,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -99303,11 +99050,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/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
@@ -99335,10 +99082,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -99412,11 +99174,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/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
@@ -99456,10 +99218,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -99517,11 +99294,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/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
@@ -99549,10 +99326,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -99610,11 +99402,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns sriov-vfs
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/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
@@ -99637,10 +99429,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -99656,7 +99447,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 @@ -99669,77 +99460,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -99871,11 +99588,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns sriov-vf
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

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
@@ -99898,10 +99615,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -99917,7 +99633,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 @@ -99930,10 +99646,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + interface-name -

PCI ID used to identify the sriov-vf

+

Name given to the interface

 path @@ -99946,77 +99662,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + pci-id -

Regional way of organizing pservers, source of truth should define values

+

PCI ID used to identify the sriov-vf

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -100208,11 +99850,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing sriov-vf
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

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
@@ -100252,10 +99894,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -100329,11 +99986,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing sriov-vf
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

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
@@ -100361,10 +100018,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -100454,11 +100126,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -100498,10 +100170,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -100575,11 +100262,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -100607,10 +100294,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -100684,11 +100386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns vlans
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
@@ -100711,10 +100413,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -100730,7 +100431,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 @@ -100743,77 +100444,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -100945,11 +100572,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns vlan
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+

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
@@ -100972,10 +100599,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -100991,7 +100617,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 @@ -101004,10 +100630,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -101020,77 +100646,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + vlan-interface -

Regional way of organizing pservers, source of truth should define values

+

String that identifies the interface

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -101252,11 +100804,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing vlan
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+

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
@@ -101296,10 +100848,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -101373,11 +100940,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing vlan
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+

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
@@ -101405,10 +100972,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -101498,11 +101080,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -101525,10 +101107,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -101544,7 +101125,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 @@ -101557,10 +101138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -101573,10 +101154,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 @@ -101589,77 +101170,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + l3-interface-ipv4-address -

Regional way of organizing pservers, source of truth should define values

+

IP address

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -101866,11 +101373,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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -101910,10 +101417,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -102003,11 +101525,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/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -102035,10 +101557,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -102144,11 +101681,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /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
@@ -102188,10 +101725,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -102281,11 +101833,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

DELETE /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
@@ -102313,10 +101865,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -102406,11 +101973,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -102433,10 +102000,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -102452,7 +102018,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 @@ -102465,10 +102031,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -102481,10 +102047,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 @@ -102497,77 +102063,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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		query - string - - -
- regional-resource-zone + l3-interface-ipv6-address -

Regional way of organizing pservers, source of truth should define values

+

IP address

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -102774,11 +102266,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 /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
@@ -102818,10 +102310,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -102911,11 +102418,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 /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
@@ -102943,10 +102450,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -103052,11 +102574,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -103096,10 +102618,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -103189,11 +102726,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -103221,10 +102758,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -103314,11 +102866,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -103358,10 +102910,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -103435,11 +103002,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/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}/relationship-list/relationship

Tags: Network
@@ -103467,10 +103034,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -103544,19 +103126,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

returns lag-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -103571,10 +103170,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -103587,77 +103185,181 @@ 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 +
+
+ +
+

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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- vnf-type + equipment-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.

querypath string +
- service-id + interface-name -

Unique identifier of service from ASDC

+

Name that identifies the link aggregate interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + - + @@ -103665,22 +103367,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- regional-resource-zone + equipment-name -

Regional way of organizing pservers, source of truth should define values

querypath string +
-

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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -103716,7 +103403,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /p-interfaces
@@ -103744,17 +103431,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interface
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
returns p-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

returns lag-interface

+

returns p-interface

@@ -103771,10 +103458,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -103790,7 +103476,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 @@ -103801,102 +103487,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -103932,7 +103528,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /p-interface
@@ -103960,17 +103556,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
create or update an existing p-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

create or update an existing lag-interface

+

create or update an existing p-interface

@@ -103979,13 +103575,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

+

p-interface object that needs to be created or updated

- /lag-interface + /p-interface
@@ -104004,10 +103600,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104023,7 +103618,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 @@ -104065,17 +103660,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing p-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

delete an existing lag-interface

+

delete an existing p-interface

@@ -104097,10 +103692,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104116,7 +103710,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 @@ -104174,11 +103768,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l-interfaces
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network
@@ -104201,10 +103795,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104220,7 +103813,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 @@ -104231,102 +103824,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -104390,11 +103893,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l-interface
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
@@ -104417,10 +103920,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104436,7 +103938,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 @@ -104463,102 +103965,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -104667,11 +104079,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l-interface
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
@@ -104711,10 +104123,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104730,7 +104141,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 @@ -104788,11 +104199,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l-interface
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
@@ -104820,10 +104231,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104839,7 +104249,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 @@ -104913,11 +104323,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
@@ -104940,10 +104350,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -104959,7 +104368,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 @@ -105002,102 +104411,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -105251,11 +104570,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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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}

Tags: Network
@@ -105295,10 +104614,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -105314,7 +104632,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 @@ -105388,11 +104706,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/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -105420,10 +104738,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -105439,7 +104756,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 @@ -105529,11 +104846,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /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
@@ -105573,10 +104890,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -105592,7 +104908,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 @@ -105666,11 +104982,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

DELETE /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
@@ -105698,10 +105014,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -105717,7 +105032,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 @@ -105791,11 +105106,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -105818,10 +105133,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -105837,7 +105151,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 @@ -105880,102 +105194,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -106129,11 +105353,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 /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
@@ -106173,10 +105397,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106192,7 +105415,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 @@ -106266,11 +105489,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 /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
@@ -106298,10 +105521,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106317,7 +105539,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 @@ -106407,11 +105629,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -106451,10 +105673,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106470,7 +105691,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 @@ -106544,11 +105765,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -106576,10 +105797,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106595,7 +105815,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 @@ -106669,11 +105889,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -106713,10 +105933,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106732,7 +105951,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 @@ -106790,11 +106009,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -106822,10 +106041,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106841,7 +106059,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 @@ -106899,11 +106117,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns sriov-vfs
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
@@ -106926,10 +106144,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -106945,7 +106162,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 @@ -106972,102 +106189,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -107176,11 +106303,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns sriov-vf
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
@@ -107203,10 +106330,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -107222,7 +106348,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 @@ -107265,102 +106391,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -107529,11 +106565,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing sriov-vf
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
@@ -107573,10 +106609,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -107592,7 +106627,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 @@ -107666,11 +106701,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing sriov-vf
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
@@ -107698,10 +106733,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -107717,7 +106751,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 @@ -107807,11 +106841,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -107851,10 +106885,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -107870,7 +106903,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 @@ -107944,11 +106977,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -107976,10 +107009,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -107995,7 +107027,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 @@ -108069,11 +107101,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns vlans
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
@@ -108096,10 +107128,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -108115,7 +107146,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 @@ -108144,10 +107175,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + prov-status -

Name of VNF.

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -108159,10 +107190,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + interface-id -

Alternate name of VNF.

+

ID of interface

 query @@ -108174,10 +107205,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + macaddr -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.

+

MAC address for the interface

 query @@ -108189,10 +107220,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + network-name -

Unique identifier of service from ASDC

+

Name of the network

 query @@ -108202,335 +107233,154 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - -
+ equipment-name + + path + string + + + +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name that identifies the physical interface

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name given to the interface

querypath string +
- heat-stack-id + vlan-interface -

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 - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlan
-

GET /network/vpes/vpe/{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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

String that identifies the interface

+ 		path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -108669,11 +107519,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing vlan
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
@@ -108713,10 +107563,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -108732,7 +107581,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 @@ -108806,11 +107655,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing vlan
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
@@ -108838,10 +107687,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -108857,7 +107705,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 @@ -108947,11 +107795,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

GET /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}

Tags: Network
@@ -108974,10 +107822,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -108993,7 +107840,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 @@ -109052,102 +107899,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -109331,11 +108088,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/vpes/vpe/{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/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}

Tags: Network
@@ -109375,10 +108132,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -109394,7 +108150,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 @@ -109484,11 +108240,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/vpes/vpe/{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/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}

Tags: Network
@@ -109516,10 +108272,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -109535,7 +108290,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 @@ -109641,11 +108396,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{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/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
@@ -109685,10 +108440,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -109704,7 +108458,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 @@ -109794,11 +108548,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{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/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
@@ -109826,10 +108580,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -109845,7 +108598,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 @@ -109935,11 +108688,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/vpes/vpe/{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/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
@@ -109962,10 +108715,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -109981,7 +108733,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 @@ -110040,102 +108792,12 @@ 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 and clients should expect changes to occur in the future to this field as ASDC matures.

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC

- 		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

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -110319,11 +108981,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 /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /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
@@ -110363,10 +109025,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -110382,7 +109043,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 @@ -110472,11 +109133,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 /network/vpes/vpe/{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 /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
@@ -110504,10 +109165,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -110523,7 +109183,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 @@ -110629,11 +109289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -110673,10 +109333,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -110692,7 +109351,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 @@ -110782,11 +109441,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -110814,10 +109473,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -110833,7 +109491,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 @@ -110923,11 +109581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -110967,10 +109625,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -110986,7 +109643,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 @@ -111060,11 +109717,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/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}/relationship-list/relationship

Tags: Network
@@ -111092,10 +109749,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -111111,7 +109767,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 @@ -111185,11 +109841,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -111229,10 +109885,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -111248,7 +109903,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 @@ -111290,11 +109945,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -111322,10 +109977,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -111341,7 +109995,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 @@ -111383,11 +110037,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpes/vpe/{vnf-id}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
@@ -111427,10 +110081,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -111472,11 +110125,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpes/vpe/{vnf-id}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
@@ -111504,10 +110157,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + equipment-name -

Unique id of VNF. This is unique across the graph.

 path @@ -111549,17 +110201,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vpls-pes
-

GET /network/vpls-pes

+
returns vpn-bindings
+

GET /network/vpn-bindings

Tags: Network
-

returns vpls-pes

+

returns vpn-bindings

@@ -111585,7 +110237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vpls-pes + /vpn-bindings
@@ -111613,17 +110265,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vpls-pe
-

GET /network/vpls-pes/vpls-pe/{equipment-name}

+
returns vpn-binding
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

returns vpls-pe

+

returns vpn-binding

@@ -111640,9 +110292,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -111655,10 +110308,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vpn-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

VPN Name

+ 		query + string + + +
+ global-route-target + +

Number used to identify a VPN, globally unique in the network

 query @@ -111694,7 +110362,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vpls-pe + /vpn-binding
@@ -111722,17 +110390,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 vpn-binding
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

create or update an existing vpls-pe

+

create or update an existing vpn-binding

@@ -111741,13 +110409,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

+

vpn-binding object that needs to be created or updated

- /vpls-pe + /vpn-binding
@@ -111766,9 +110434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -111810,17 +110479,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vpls-pe
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

+
delete an existing vpn-binding
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

delete an existing vpls-pe

+

delete an existing vpn-binding

@@ -111842,9 +110511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -111902,19 +110572,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network
-

returns lag-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -111929,9 +110616,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -111942,25 +110630,128 @@ 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/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - +
- prov-status + vpn-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

VPN ID, globally unique within A&AI

querypath 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

@@ -111983,7 +110774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /models
@@ -112011,17 +110802,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
returns model
+

GET /service-design-and-creation/models/model/{model-name-version-id}

Tags: - Network + ServiceDesignAndCreation
-

returns lag-interface

+

returns model

@@ -112038,9 +110829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112053,26 +110845,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-type -

Name that identifies the link aggregate interface

+

Type of the model, e.g., service, resource, widget, etc.

pathquery string -
- prov-status + model-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name of the model, which can change from version to version.

+ 		query + string + + +
+ model-id + +

Invariant unique ID which does not change from version to version

+ 		query + string + + +
+ model-version + +

Version

 query @@ -112108,7 +110929,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /model
@@ -112136,17 +110957,17 @@ 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}

+
create or update an existing model
+

PUT /service-design-and-creation/models/model/{model-name-version-id}

Tags: - Network + ServiceDesignAndCreation
-

create or update an existing lag-interface

+

create or update an existing model

@@ -112155,13 +110976,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

+

model object that needs to be created or updated

- /lag-interface + /model
@@ -112180,25 +111001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112240,17 +111046,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 model
+

DELETE /service-design-and-creation/models/model/{model-name-version-id}

Tags: - Network + ServiceDesignAndCreation
-

delete an existing lag-interface

+

delete an existing model

@@ -112272,25 +111078,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112348,17 +111139,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 metadata
+

GET /service-design-and-creation/models/model/{model-name-version-id}/metadata

Tags: - Network + ServiceDesignAndCreation
-

returns l-interfaces

+

returns metadata

@@ -112375,9 +111166,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112390,26 +111182,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-type -

Name that identifies the link aggregate interface

+

Type of the model, e.g., service, resource, widget, etc.

pathquery string -
- prov-status + model-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name of the model, which can change from version to version.

+ 		query + string + + +
+ model-id + +

Invariant unique ID which does not change from version to version

+ 		query + string + + +
+ model-version + +

Version

 query @@ -112445,7 +111266,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /metadata
@@ -112473,17 +111294,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 metadatum
+

GET /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

Tags: - Network + ServiceDesignAndCreation
-

returns l-interface

+

returns metadatum

@@ -112500,25 +111321,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112531,10 +111337,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + metaname -

Name given to the interface

 path @@ -112547,10 +111352,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + model-type -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Type of the model, e.g., service, resource, widget, etc.

 query @@ -112562,10 +111367,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + model-name -

ID of interface

+

Name of the model, which can change from version to version.

 query @@ -112577,10 +111382,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + model-id -

MAC address for the interface

+

Invariant unique ID which does not change from version to version

 query @@ -112592,10 +111397,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-version -

Name of the network

+

Version

 query @@ -112631,7 +111436,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /metadatum
@@ -112659,17 +111464,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 metadatum
+

PUT /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

Tags: - Network + ServiceDesignAndCreation
-

create or update an existing l-interface

+

create or update an existing metadatum

@@ -112678,13 +111483,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

+

metadatum object that needs to be created or updated

- /l-interface + /metadatum
@@ -112703,25 +111508,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112734,10 +111524,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + metaname -

Name given to the interface

 path @@ -112779,17 +111568,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 metadatum
+

DELETE /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

Tags: - Network + ServiceDesignAndCreation
-

delete an existing l-interface

+

delete an existing metadatum

@@ -112811,25 +111600,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112842,10 +111616,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + metaname -

Name given to the interface

 path @@ -112903,17 +111676,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 model-elements
+

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements

Tags: - Network + ServiceDesignAndCreation
-

returns l3-interface-ipv4-address-list

+

returns model-elements

@@ -112930,9 +111703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -112945,58 +111719,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-type -

Name that identifies the link aggregate interface

+

Type of the model, e.g., service, resource, widget, etc.

pathquery string -
- interface-name + model-name -

Name given to the interface

+

Name of the model, which can change from version to version.

pathquery string -
- l3-interface-ipv4-address + model-id -

IP address

+

Invariant unique ID which does not change from version to version

pathquery string -
- prov-status + model-version -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Version

 query @@ -113006,42 +111777,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-elements +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns model-element
+

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

returns model-element

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - - - - - - - - - - - - - - + - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - -
- interface-id + model-name-version-id -

ID of interface

+

Unique identifier corresponding to one version of a model in ASDC

querypath string +
- macaddr + model-element-uuid -

MAC address for the interface

querypath string +
- network-name + model-type -

Name of the network

+

Type of the model, e.g., service, resource, widget, etc.

 query @@ -113053,14 +111904,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + model-name -

Inner VLAN tag

+

Name of the model, which can change from version to version.

 query - integer + string @@ -113068,10 +111919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + model-id -

Neutron network id of the interface that address belongs to

+

Invariant unique ID which does not change from version to version

 query @@ -113083,10 +111934,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + model-version -

Neutron id of subnet that address belongs to

+

Version

 query @@ -113122,7 +111973,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /model-element
@@ -113150,17 +112001,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing model-element
+

PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

Tags: - Network + ServiceDesignAndCreation
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing model-element

@@ -113169,13 +112020,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

+

model-element object that needs to be created or updated

- /l3-interface-ipv4-address-list + /model-element
@@ -113194,41 +112045,10 @@ 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 - - - -
- interface-name + model-name-version-id -

Name given to the interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -113241,10 +112061,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + model-element-uuid -

IP address

 path @@ -113286,17 +112105,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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing model-element
+

DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

Tags: - Network + ServiceDesignAndCreation
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing model-element

@@ -113318,41 +112137,10 @@ 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 - - - -
- interface-name + model-name-version-id -

Name given to the interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -113365,10 +112153,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + model-element-uuid -

IP address

 path @@ -113426,36 +112213,19 @@ 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

+
returns model-constraints
+

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

Tags: - Network + ServiceDesignAndCreation
-

see node definition for valid relationships

+

returns model-constraints

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -113470,41 +112240,10 @@ 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 - - - -
- interface-name + model-name-version-id -

Name given to the interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -113517,10 +112256,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + model-element-uuid -

IP address

 path @@ -113531,128 +112269,64 @@ 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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - + - + - + @@ -113664,6 +112338,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-constraints +
+
+
+ +
default @@ -113686,17 +112383,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 model-constraint
+

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: - Network + ServiceDesignAndCreation
-

returns l3-interface-ipv6-address-list

+

returns model-constraint

@@ -113713,25 +112410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- equipment-name + model-type +

Type of the model, e.g., service, resource, widget, etc.

pathquery string -
- interface-name + model-name -

Name that identifies the link aggregate interface

+

Name of the model, which can change from version to version.

pathquery string -
- interface-name + model-id -

Name given to the interface

+

Invariant unique ID which does not change from version to version

pathquery string -
- l3-interface-ipv4-address + model-version -

IP address

+

Version

pathquery string -
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -113744,10 +112426,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name given to the interface

 path @@ -113760,10 +112441,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + model-constraint-uuid -

IP address

 path @@ -113776,40 +112456,10 @@ 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 - - -
- macaddr + model-type -

MAC address for the interface

+

Type of the model, e.g., service, resource, widget, etc.

 query @@ -113821,10 +112471,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-name -

Name of the network

+

Name of the model, which can change from version to version.

 query @@ -113836,25 +112486,10 @@ 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 + model-id -

Neutron network id of the interface that address belongs to

+

Invariant unique ID which does not change from version to version

 query @@ -113866,10 +112501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + model-version -

Neutron id of subnet that address belongs to

+

Version

 query @@ -113905,7 +112540,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /model-constraint
@@ -113933,17 +112568,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 model-constraint
+

PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: - Network + ServiceDesignAndCreation
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing model-constraint

@@ -113952,13 +112587,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

+

model-constraint object that needs to be created or updated

- /l3-interface-ipv6-address-list + /model-constraint
@@ -113977,25 +112612,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114008,10 +112628,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name given to the interface

 path @@ -114024,10 +112643,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + model-constraint-uuid -

IP address

 path @@ -114069,17 +112687,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 model-constraint
+

DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: - Network + ServiceDesignAndCreation
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing model-constraint

@@ -114101,25 +112719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + model-name-version-id -

Name that identifies the link aggregate interface

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114132,10 +112735,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name given to the interface

 path @@ -114148,10 +112750,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + model-constraint-uuid -

IP address

 path @@ -114209,36 +112810,19 @@ 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

+
returns constrained-element-sets
+

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

Tags: - Network + ServiceDesignAndCreation
-

see node definition for valid relationships

+

returns constrained-element-sets

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -114253,9 +112837,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + @@ -114323,6 +112950,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-sets +
+
+
+ +
default @@ -114345,24 +112995,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns constrained-element-set
+

GET /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

delete an existing relationship

+

returns constrained-element-set

-
- -

application/json application/xml -

-
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114268,10 +112853,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114284,10 +112868,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -114300,18 +112883,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + model-type -

IP address

+

Type of the model, e.g., service, resource, widget, etc.

pathquery + string + + +
+ model-name + +

Name of the model, which can change from version to version.

+ 		query + string + + +
+ model-id + +

Invariant unique ID which does not change from version to version

+ 		query + string + + +
+ model-version + +

Version

+ 		query string -
@@ -114377,9 +113022,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114392,10 +113038,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114408,10 +113053,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -114424,10 +113068,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + constrained-element-set-uuid -

IP address

 path @@ -114438,6 +113081,66 @@ 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-id + +

Invariant unique ID which does not change from version to version

+ 		query + string + + +
+ model-version + +

Version

+ 		query + string + + +
@@ -114447,6 +113150,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-set +
+
+
+ +
default @@ -114469,17 +113195,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}/relationship-list/relationship

+
create or update an existing constrained-element-set
+

PUT /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

see node definition for valid relationships

+

create or update an existing constrained-element-set

@@ -114488,13 +113214,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

+

constrained-element-set object that needs to be created or updated

- /relationship + /constrained-element-set
@@ -114513,9 +113239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114528,10 +113255,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114544,10 +113270,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid -

Name given to the interface

 path @@ -114589,17 +113329,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}/relationship-list/relationship

+
delete an existing constrained-element-set
+

DELETE /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

delete an existing relationship

+

delete an existing constrained-element-set

@@ -114621,9 +113361,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114636,10 +113377,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114652,10 +113392,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -114666,6 +113405,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ constrained-element-set-uuid + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -114697,17 +113467,17 @@ 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

+
returns element-choice-sets
+

GET /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

returns sriov-vfs

+

returns element-choice-sets

@@ -114724,9 +113494,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114739,10 +113510,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114755,10 +113525,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -114771,10 +113540,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + constrained-element-set-uuid -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		path + string + + + +
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

 query @@ -114786,10 +113570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + model-name -

ID of interface

+

Name of the model, which can change from version to version.

 query @@ -114801,10 +113585,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + model-id -

MAC address for the interface

+

Invariant unique ID which does not change from version to version

 query @@ -114816,10 +113600,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-version -

Name of the network

+

Version

 query @@ -114855,7 +113639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /element-choice-sets
@@ -114883,17 +113667,17 @@ 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}

+
returns element-choice-set
+

GET /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

returns sriov-vf

+

returns element-choice-set

@@ -114910,9 +113694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -114925,10 +113710,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -114941,10 +113725,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -114957,10 +113740,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + constrained-element-set-uuid -

PCI ID used to identify the sriov-vf

 path @@ -114973,55 +113755,25 @@ 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 - - -
- macaddr + element-choice-set-uuid -

MAC address for the interface

querypath string +
- network-name + model-type -

Name of the network

+

Type of the model, e.g., service, resource, widget, etc.

 query @@ -115033,10 +113785,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + model-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name of the model, which can change from version to version.

 query @@ -115048,10 +113800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + model-id -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Invariant unique ID which does not change from version to version

 query @@ -115063,25 +113815,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 + model-version -

Neutron network id of the interface

+

Version

 query @@ -115117,7 +113854,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /element-choice-set
@@ -115145,17 +113882,17 @@ 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}

+
create or update an existing element-choice-set
+

PUT /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

create or update an existing sriov-vf

+

create or update an existing element-choice-set

@@ -115164,13 +113901,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

+

element-choice-set object that needs to be created or updated

- /sriov-vf + /element-choice-set
@@ -115189,9 +113926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -115204,10 +113942,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -115220,10 +113957,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -115236,10 +113972,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid -

PCI ID used to identify the sriov-vf

 path @@ -115281,17 +114031,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 element-choice-set
+

DELETE /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
-

delete an existing sriov-vf

+

delete an existing element-choice-set

@@ -115313,9 +114063,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + model-name-version-id +

Unique identifier corresponding to one version of a model in ASDC

 path @@ -115328,10 +114079,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-element-uuid -

Name that identifies the link aggregate interface

 path @@ -115344,10 +114094,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + model-constraint-uuid -

Name given to the interface

 path @@ -115360,10 +114109,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + constrained-element-set-uuid + + path + string + + + +
+ element-choice-set-uuid -

PCI ID used to identify the sriov-vf

 path @@ -115421,13 +114184,13 @@ 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 /service-design-and-creation/models/model/{model-name-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: - Network + ServiceDesignAndCreation
@@ -115465,57 +114228,10 @@ 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 - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + model-name-version-id -

PCI ID used to identify the sriov-vf

+

Unique identifier corresponding to one version of a model in ASDC

 path @@ -115526,70 +114242,9 @@ 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 -

-
-
- - - - - - - - - - - @@ -115604,10 +114259,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- equipment-name + model-element-uuid
- interface-name + model-constraint-uuid -

Name that identifies the link aggregate interface

 path @@ -115620,10 +114274,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + constrained-element-set-uuid -

Name given to the interface

 path @@ -115636,13955 +114289,7 @@ 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 - - - -
-
- -
-

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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- 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 - - -
- 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/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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU 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 - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
-
- default - -
-
-
-
-

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

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- l3-interface-ipv4-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 - - -
- 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

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 -
-
-
-

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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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}/lag-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

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/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 -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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 - - -
- 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

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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}/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

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/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 -
-
-
-

delete an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - 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 relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns p-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

- Tags: - Network -
-
-
-

returns p-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

- -
-
-
- -
-
- -
- /p-interfaces -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns p-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

- Tags: - Network -
-
-
-

returns p-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		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

- -
-
-
- -
-
- -
- /p-interface -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing p-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

- Tags: - Network -
-
-
-

create or update an existing p-interface

- -
-
- -

application/json application/xml -

-
-
-

p-interface object that needs to be created or updated

-

-
-
-
-
- /p-interface -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing p-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

- Tags: - Network -
-
-
-

delete an existing p-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

- Tags: - Network -
-
-
-

returns l-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		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

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

returns l-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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 - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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

-

-
-
-
-
- /l-interface -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

delete an existing l-interface

- -
-
- -

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 - - - -
- 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}/p-interfaces/p-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 - - 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 - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU 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 - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv4-address-list
-

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}

- 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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-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 - - -
- 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

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- 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

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-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/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 -
-
-
-

delete an existing l3-interface-ipv6-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-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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-ipv6-address - -

IP address

- 		path - string - - - -
-
- -
-

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-ipv6-address-list/{l3-interface-ipv6-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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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 - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vfs
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

- Tags: - Network -
-
-
-

returns sriov-vfs

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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 - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns sriov-vf
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

returns sriov-vf

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - 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 - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU 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 - - -
-
- -
-

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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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

-

-
-
-
-
- /sriov-vf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - 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 - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing sriov-vf
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

delete an existing sriov-vf

- -
-
- -

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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - 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 - - - -
-
- -
-

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}/sriov-vfs/sriov-vf/{pci-id}/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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

- Tags: - Network -
-
-
-

returns vlans

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical 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 - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

returns vlan

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU 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 - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing vlan
-

PUT /network/vpls-pes/vpls-pe/{equipment-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

- -
-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated

-

-
-
-
-
- /vlan -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vlan
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

- Tags: - Network -
-
-
-

delete an existing vlan

- -
-
- -

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 - - - -
- 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}/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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU 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 - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- 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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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}/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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
- 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/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 -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-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 - - -
- 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

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- 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

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-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/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 -
-
-
-

delete an existing l3-interface-ipv6-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 - - - -
- 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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-ipv6-address - -

IP address

- 		path - string - - - -
-
- -
-

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}/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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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-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/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
-
- -
-

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}/vlans/vlan/{vlan-interface}/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 - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - 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 -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpn-bindings -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vpn-binding
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}

- Tags: - Network -
-
-
-

returns vpn-binding

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

- 		path - string - - - -
- vpn-name - -

VPN Name

- 		query - string - - -
- global-route-target - -

Number used to identify a VPN, globally unique in the network

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpn-binding -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing vpn-binding
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

- Tags: - Network -
-
-
-

create or update an existing vpn-binding

- -
-
- -

application/json application/xml -

-
-
-

vpn-binding object that needs to be created or updated

-

-
-
-
-
- /vpn-binding -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vpn-binding
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

- Tags: - Network -
-
-
-

delete an existing vpn-binding

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

- 		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/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- vpn-id - -

VPN ID, globally unique within A&AI

- 		path - 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 -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /models -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model
-

GET /service-design-and-creation/models/model/{model-name-version-id}

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing model
-

PUT /service-design-and-creation/models/model/{model-name-version-id}

- Tags: - ServiceDesignAndCreation -
-
-
-

create or update an existing model

- -
-
- -

application/json application/xml -

-
-
-

model object that needs to be created or updated

-

-
-
-
-
- /model -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing model
-

DELETE /service-design-and-creation/models/model/{model-name-version-id}

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing model

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns metadata
-

GET /service-design-and-creation/models/model/{model-name-version-id}/metadata

- Tags: - ServiceDesignAndCreation -
-
-
-

returns metadata

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns metadatum
-

GET /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

- Tags: - ServiceDesignAndCreation -
-
-
-

returns metadatum

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- metaname - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadatum -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing metadatum
-

PUT /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

- Tags: - ServiceDesignAndCreation -
-
-
-

create or update an existing metadatum

- -
-
- -

application/json application/xml -

-
-
-

metadatum object that needs to be created or updated

-

-
-
-
-
- /metadatum -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- metaname - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing metadatum
-

DELETE /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing metadatum

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- metaname - - path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model-elements
-

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model-elements

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-elements -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model-element
-

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model-element

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-element -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing model-element
-

PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

- Tags: - ServiceDesignAndCreation -
-
-
-

create or update an existing model-element

- -
-
- -

application/json application/xml -

-
-
-

model-element object that needs to be created or updated

-

-
-
-
-
- /model-element -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing model-element
-

DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing model-element

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model-constraints
-

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model-constraints

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-constraints -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model-constraint
-

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model-constraint

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-constraint -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing model-constraint
-

PUT /service-design-and-creation/models/model/{model-name-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

-

-
-
-
-
- /model-constraint -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing model-constraint
-

DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing model-constraint

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns constrained-element-sets
-

GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

- Tags: - ServiceDesignAndCreation -
-
-
-

returns constrained-element-sets

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /constrained-element-sets -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns constrained-element-set
-

GET /service-design-and-creation/models/model/{model-name-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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /constrained-element-set -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing constrained-element-set
-

PUT /service-design-and-creation/models/model/{model-name-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

- -
-
- -

application/json application/xml -

-
-
-

constrained-element-set object that needs to be created or updated

-

-
-
-
-
- /constrained-element-set -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing constrained-element-set
-

DELETE /service-design-and-creation/models/model/{model-name-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 -
-
-
-

delete an existing constrained-element-set

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns element-choice-sets
-

GET /service-design-and-creation/models/model/{model-name-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 -
-
-
-

returns element-choice-sets

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /element-choice-sets -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns element-choice-set
-

GET /service-design-and-creation/models/model/{model-name-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

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- element-choice-set-uuid - - path - string - - - -
- 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-id - -

Invariant unique ID which does not change from version to version

- 		query - string - - -
- model-version - -

Version

- 		query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /element-choice-set -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing element-choice-set
-

PUT /service-design-and-creation/models/model/{model-name-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

- -
-
- -

application/json application/xml -

-
-
-

element-choice-set object that needs to be created or updated

-

-
-
-
-
- /element-choice-set -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- element-choice-set-uuid - - path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing element-choice-set
-

DELETE /service-design-and-creation/models/model/{model-name-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 -
-
-
-

delete an existing element-choice-set

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- model-name-version-id - -

Unique identifier corresponding to one version of a model in ASDC

- 		path - string - - - -
- model-element-uuid - - path - string - - - -
- model-constraint-uuid - - path - string - - - -
- constrained-element-set-uuid - - path - string - - - -
- element-choice-set-uuid - - 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 /service-design-and-creation/models/model/{model-name-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 -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -134588,9 +119293,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

ERROR_IF_ANY_IN_EDGES

    +
  • TO complex (Many2Many)
    • +
  • TO service-capability (Many2Many)
  • FROM cloud-region (is composed of availability-zone)
    • +
  • FROM ctag-pool
    • +
  • FROM dvs-switch
  • FROM generic-vnf
    • -
  • FROM pserver
+
  • FROM pserver
    • +
  • FROM vce
    • @@ -134839,6 +119549,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
      +
    • FROM site-pair (is composed of class-of-service)
    + +
    @@ -135088,16 +119804,19 @@ 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. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.

    +

    cloud-region designates an installation of a cloud cluster or region or instantiation.

    Default Delete Scope

    THIS_NODE_ONLY

      +
    • TO complex (Many2One)
    • TO l3-network (Many2Many)
    • TO tenant (comprises cloud-region, One2Many)
    • TO image (comprises cloud-region, One2Many)
    • TO flavor (comprises cloud-region, One2Many)
    • TO availability-zone (comprises cloud-region, One2Many)
      • +
    • TO oam-network (comprises cloud-region, One2Many)
      • +
    • TO dvs-switch (comprises cloud-region, One2Many)
    • TO volume-group (comprises cloud-region, One2Many)
    • TO group-assignment (comprises cloud-region, One2Many)
    • TO snapshot (comprises cloud-region, One2Many)
      • @@ -135470,6 +120189,18 @@ 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 ctag-pool (comprises complex, Many2Many)
        • +
      • TO l3-network (Many2Many)
        • +
      • FROM availability-zone
        • +
      • FROM cloud-region
        • +
      • FROM oam-network
        • +
      • FROM pserver
        • +
      • FROM pnf
        • +
      • FROM vce
        • +
      • FROM vpls-pe
        • +
      • FROM volume-group
      @@ -135772,6 +120503,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 (Many2Many)
        • +
      • TO metadatum (comprises connector, Many2Many)
        • +
      • FROM service-instance
      @@ -136216,6 +120952,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 availability-zone (Many2Many)
        • +
      • FROM complex (is composed of ctag-pool)
        • +
      • FROM vpls-pe
      @@ -136614,6 +121355,10 @@ 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 availability-zone (Many2Many)
        • +
      • FROM cloud-region (is composed of dvs-switch)
      @@ -136692,7 +121437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -

      Collection of digital virtual switch metadata used for vmWare VCEs and VPEs.

      +

      Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

      @@ -137414,16 +122159,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      CASCADE_TO_CHILDREN

        +
      • TO license-key-resource (Many2Many)
      • TO l-interface (comprises generic-vnf, Many2Many)
      • TO availability-zone (Many2Many)
      • TO lag-interface (comprises generic-vnf, Many2Many)
      • TO l3-network (Many2Many)
      • TO pserver (Many2Many)
        • +
      • TO vnf-image (Many2One)
      • TO vserver (One2Many)
      • TO service-instance (Many2Many)
        • +
      • TO site-pair-set (Many2Many)
        • +
      • TO network-profile (Many2Many)
        • +
      • TO ipsec-configuration (Many2One)
      • TO vf-module (comprises generic-vnf, One2Many)
      • TO volume-group (One2Many)
        • -
      • TO vnfc (One2Many, will delete target node)
        • +
      • TO vnfc (One2Many)
        • +
      • FROM virtual-data-center
      • FROM logical-link
    @@ -138158,7 +122909,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO metadata (comprises image, Many2Many)
    • TO metadatum (comprises image, Many2Many)
    • FROM cloud-region (is composed of image)
    • FROM vserver
    @@ -138867,6 +123617,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

    + +
      +
    • TO vig-server (comprises ipsec-configuration, One2Many)
      • +
    • FROM generic-vnf
    @@ -139275,10 +124029,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
    • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
      • -
    • TO logical-link (Many2Many, will delete target node)
      • +
    • TO logical-link (Many2Many)
    • TO vlan (comprises l-interface, Many2Many)
      • +
    • TO sriov-vf (comprises l-interface, One2One)
    • FROM generic-vnf (is composed of l-interface)
    • FROM lag-interface (is composed of l-interface)
      • +
    • FROM newvce (is composed of l-interface)
    • FROM p-interface (is composed of l-interface)
    • FROM vserver (is composed of l-interface)
    @@ -139848,11 +124604,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    CASCADE_TO_CHILDREN

      +
    • TO vpn-binding (Many2Many)
    • TO subnet (comprises l3-network, Many2Many)
    • TO service-instance (Many2Many)
    • TO ctag-assignment (comprises l3-network, Many2Many)
      • +
    • TO network-policy (Many2Many)
    • TO segmentation-assignment (comprises l3-network, One2Many)
      • +
    • TO route-table-reference (Many2Many)
    • FROM cloud-region
      • +
    • FROM complex
    • FROM generic-vnf
    • FROM l3-interface-ipv4-address-list
    • FROM l3-interface-ipv6-address-list
      • @@ -140278,11 +125038,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      CASCADE_TO_CHILDREN

        +
      • TO lag-link (Many2Many)
      • TO p-interface (Many2Many)
      • TO l-interface (comprises lag-interface, Many2Many)
      • FROM generic-vnf (is composed of lag-interface)
      • FROM pserver (is composed of lag-interface)
        • -
      • FROM pnf (is composed of lag-interface)
      +
    • FROM pnf (is composed of lag-interface)
      • +
    • FROM vpls-pe (is composed of lag-interface)
    @@ -140434,6 +125196,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
      • +
    • FROM logical-link
    @@ -140545,15 +125311,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    THIS_NODE_ONLY

      +
    • TO lag-link (Many2Many)
    • TO pnf (Many2Many)
    • TO logical-link (One2Many)
    • TO generic-vnf (Many2Many)
    • TO pserver (Many2Many)
    • FROM l-interface
      • -
    • FROM logical-link
    • FROM p-interface
    • FROM service-instance
      • -
    • FROM vlan
    +
  • FROM virtual-data-center
    • +
  • FROM vlan
    • +
  • FROM logical-link
    • @@ -140832,9 +125600,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of metadatum (key/value pairs)

    Default Delete Scope

    THIS_NODE_ONLY

    - -
      -
    • FROM image (is composed of metadata)
    @@ -140881,7 +125646,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • FROM image (is composed of metadatum)
      • -
    • FROM service-instance (is composed of metadatum)
    +
  • FROM model (is composed of metadatum)
    • +
  • FROM service-instance (is composed of metadatum)
    • +
  • FROM connector (is composed of metadatum)
    • @@ -140943,6 +125710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    ERROR_4_IN_EDGES_OR_CASCADE

      +
    • TO model (Many2One)
      • +
    • TO model-element (comprises model, One2Many)
      • +
    • TO metadatum (comprises model, One2Many)
      • +
    • FROM model-element
    • FROM named-query
    • FROM named-query-element
    @@ -141297,11 +126068,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    CASCADE_TO_CHILDREN

      +
    • TO model (Many2One)
    • TO model-element (comprises model-element, One2Many)
    • TO model-constraint (comprises model-element, One2Many)
    • TO constrained-element-set (comprises model-element, One2Many)
      • -
    • FROM model-element (is composed of model-element)
      • -
    • FROM element-choice-set (is composed of model-element)
    +
  • FROM model (is composed of model-element)
    • +
  • FROM element-choice-set (is composed of model-element)
    • +
  • FROM model-element (is composed of model-element)
    • @@ -141520,6 +126293,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
      +
    • FROM vlan
    + +
    @@ -142153,26 +126932,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - vpes: - object[] - - -
    -
    - -
    - -
    - vpe - - - -
    - -
    -
    -
    vnfcs: object[] @@ -142424,6 +127183,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
      +
    • FROM l3-network
    + +
    @@ -142512,6 +127277,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Network profile populated by SDN-GP for SNMP

    + +
      +
    • FROM generic-vnf
    @@ -142631,6 +127399,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.

    + +
      +
    • TO l-interface (comprises newvce, Many2Many)
    @@ -142730,7 +127501,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).

    +

    Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

    @@ -142742,7 +127513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Client should send valid enumerated value, e.g., VPE.

    +

    Client should send valid enumerated value.

    @@ -143194,6 +127965,11 @@ 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 complex (Many2Many)
      • +
    • TO service-capability (Many2Many)
      • +
    • FROM cloud-region (is composed of oam-network)
    @@ -143356,11 +128132,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • TO l-interface (comprises p-interface, Many2Many)
      • -
    • TO physical-link (Many2Many, will delete target node)
      • +
    • TO physical-link (Many2Many)
    • TO logical-link (Many2One)
    • FROM lag-interface
    • FROM pserver (is composed of p-interface)
      • -
    • FROM pnf (is composed of p-interface)
    +
  • FROM pnf (is composed of p-interface)
    • +
  • FROM vpls-pe (is composed of p-interface)
    • @@ -143750,8 +128527,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • TO p-interface (comprises pnf, Many2Many)
    • TO lag-interface (comprises pnf, One2Many)
      • -
    • FROM logical-link
      • -
    • FROM service-instance
    +
  • TO complex (Many2One)
    • +
  • FROM logical-link
    • @@ -144043,6 +128820,10 @@ 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 cvlan-tag (comprises port-group, Many2Many)
      • +
    • FROM vce (is composed of port-group)
    @@ -144442,6 +129223,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    ERROR_4_IN_EDGES_OR_CASCADE

      +
    • TO complex (Many2One)
    • TO cloud-region (Many2One)
    • TO availability-zone (Many2One)
    • TO lag-interface (comprises pserver, Many2Many)
      • @@ -145384,6 +130166,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      Openstack route table reference.

      + +
        +
      • FROM l3-network
      @@ -145502,6 +130287,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      +
      + +
        +
      • TO site-pair (comprises routing-instance, Many2Many)
        • +
      • FROM site-pair-set (is composed of routing-instance)
      + +
      @@ -146138,6 +130930,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
        • +
      • FROM oam-network
      @@ -146342,14 +131138,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      CASCADE_TO_CHILDREN

        -
      • TO pnf (One2Many)
        • +
      • TO cvlan-tag (Many2Many)
        • +
      • TO connector (Many2Many)
      • TO metadatum (comprises service-instance, Many2Many)
        • -
      • TO logical-link (Many2Many, will delete target node)
        • +
      • TO logical-link (Many2Many)
      • TO vlan (One2Many)
      • TO service-instance (One2Many)
      • FROM generic-vnf
      • FROM l3-network
      • FROM service-subscription (is composed of service-instance)
        • +
      • FROM vce
      • FROM service-instance
      @@ -146819,6 +131617,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      +
      + +
        +
      • TO class-of-service (comprises site-pair, Many2Many)
        • +
      • FROM routing-instance (is composed of site-pair)
      + +
      @@ -146963,6 +131768,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 routing-instance (comprises site-pair-set, Many2Many)
        • +
      • FROM generic-vnf
      @@ -147352,6 +132161,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)

      + +
        +
      • FROM l-interface (is composed of sriov-vf)
      @@ -147642,7 +132454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      Default Delete Scope
      -

      THIS_NODE_ONLY

      +

      ERROR_IF_ANY_IN_EDGES

      • FROM l3-interface-ipv4-address-list
        • @@ -148181,6 +132993,13 @@ 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 (Many2Many)
          • +
        • TO complex (Many2Many)
          • +
        • TO port-group (comprises vce, Many2Many)
          • +
        • TO vserver (Many2Many)
          • +
        • TO service-instance (Many2Many)
        @@ -148520,7 +133339,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
        • TO volume-group (One2One)
        • TO l3-network (Many2Many)
          • -
        • TO vnfc (One2Many, will delete target node)
          • +
        • TO vnfc (One2Many)
        • FROM vserver
        • FROM generic-vnf (is composed of vf-module)
        @@ -148750,6 +133569,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

        + +
          +
        • FROM ipsec-configuration (is composed of vig-server)
        @@ -148877,6 +133699,11 @@ 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

        + +
          +
        • TO generic-vnf (Many2Many)
          • +
        • TO logical-link (Many2Many)
          • +
        • FROM connector
        @@ -149003,7 +133830,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
        • TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
        • TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
          • -
        • TO logical-link (Many2Many, will delete target node)
          • +
        • TO multicast-configuration (Many2Many)
          • +
        • TO logical-link (One2One)
        • FROM l-interface (is composed of vlan)
        • FROM service-instance
        @@ -149267,6 +134095,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
        @@ -149723,6 +134554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

        THIS_NODE_ONLY

          +
        • TO complex (Many2Many)
        • TO tenant (Many2Many)
        • FROM cloud-region (is composed of volume-group)
        • FROM vf-module
          • @@ -149913,395 +134745,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
      -
      -

      vpe: - object - - - -

      -
      -
      -
      -

      Relationship-list must include related to info for complex.

      - -
      - -
      -
      -
      - vnf-id: - string - - - -
      -
      -

      Unique id of VNF. This is unique across the graph.

      -
      - -
      -
      -
      - vnf-name: - string - - - -
      -
      -

      Name of VNF.

      -
      - -
      -
      -
      - vnf-name2: - string - - -
      -
      -

      Alternate name of VNF.

      -
      - -
      -
      -
      - vnf-type: - string - - - -
      -
      -

      String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.

      -
      - -
      -
      -
      - service-id: - string - - -
      -
      -

      Unique identifier of service from ASDC

      -
      - -
      -
      -
      - regional-resource-zone: - string - - -
      -
      -

      Regional way of organizing pservers, source of truth should define values

      -
      - -
      -
      -
      - prov-status: - string - - -
      -
      -

      Trigger for operational monitoring of this resource by Service Assurance systems.

      -
      - -
      -
      -
      - operational-state: - string - - -
      -
      -

      Indicator for whether the resource is considered operational

      -
      - -
      -
      -
      - license-key: - string - - -
      -
      -

      License key

      -
      - -
      -
      -
      - equipment-role: - string - - -
      -
      -

      Client should send valid enumerated value

      -
      - -
      -
      -
      - orchestration-status: - string - - -
      -
      -

      Orchestration status of this VNF, mastered by MSO

      -
      - -
      -
      -
      - heat-stack-id: - string - - -
      -
      -

      Heat stack id corresponding to this instance, managed by MSO

      -
      - -
      -
      -
      - mso-catalog-key: - string - - -
      -
      -

      Corresponds to the SDN-C catalog id used to configure this VCE

      -
      - -
      -
      -
      - ipv4-oam-address: - string - - -
      -
      -

      Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).

      -
      - -
      -
      -
      - ipv4-oam-gateway-address-prefix-length: - integer - - -
      -
      -

      Prefix length for oam-address

      -
      - -
      -
      -
      - ipv4-oam-gateway-address: - string - - -
      -
      -

      Gateway address

      -
      - -
      -
      -
      - v4-loopback0-ip-address: - string - - -
      -
      -

      Loopback0 address

      -
      - -
      -
      -
      - vlan-id-outer: - integer - - -
      -
      -

      Temporary location for stag to get to VCE

      -
      - -
      -
      -
      - as-number: - string - - -
      -
      -

      as-number of the VPE

      -
      - -
      -
      -
      - resource-version: - string - - -
      -
      -

      Used for optimistic concurrency. Must be empty on create, valid on update and delete.

      -
      - -
      -
      -
      - summary-status: - string - - -
      -
      -

      details regarding the vpe operation

      -
      - -
      -
      -
      - encrypted-access-flag: - boolean - - -
      -
      -

      indicates whether vpe access uses SSH

      -
      - -
      -
      -
      - relationship-list: - object[] - - -
      -
      - -
      - -
      - relationship - - - -
      - -
      -
      -
      -
      - l-interfaces: - object[] - - -
      -
      - -
      - -
      - l-interface - - - -
      - -
      -
      -
      -
      - lag-interfaces: - object[] - - -
      -
      - -
      - -
      - lag-interface - - - -
      - -
      -
      -
      -
      -
      -
      -
      -
      -
      -

      vpes: - object - - - -

      -
      -
      -
      -

      Virtual provider edge router. In 1504, A&AI will populate this object through an M&P and tool provided to operations.

      - -
      - -
      -
      -
      - vpe: - object[] - - -
      -
      - -
      - -
      - vpe - - - -
      - -
      -
      -
      -
      -
      -
      -

      vpls-pe: @@ -150314,6 +134757,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      VPLS Provider Edge routers.

      + +
        +
      • TO complex (Many2Many)
        • +
      • TO ctag-pool (Many2Many)
        • +
      • TO p-interface (comprises vpls-pe, Many2Many)
        • +
      • TO lag-interface (comprises vpls-pe, Many2Many)
      @@ -150350,7 +134799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -

      Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).

      +

      Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

      @@ -150508,6 +134957,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

      VPN binding

      + +
        +
      • FROM l3-network
      @@ -150655,7 +135107,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      • TO flavor (Many2One)
      • TO image (Many2One)
        • -
      • TO ipaddress (comprises vserver, Many2Many)
      • TO l-interface (comprises vserver, Many2Many)
      • TO pserver (Many2One)
      • TO volume (comprises vserver, Many2Many)
        • @@ -150663,7 +135114,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      • TO snapshot (One2One)
      • TO vf-module (Many2One)
      • FROM generic-vnf
        • -
      • FROM tenant (is composed of vserver)
      +
    • FROM tenant (is composed of vserver)
      • +
    • FROM vce

    diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_bulk_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_bulk_v12.yaml index f274e993..a6d27037 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_bulk_v12.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_bulk_v12.yaml @@ -42,7 +42,7 @@ paths: - application/xml responses: "default": - description: Response codes found in [response codes](https://wiki.web.att.com/display/UAAI/Alarm+Log). + description: Response codes found in [response codes]. "all success": description: Below is the response for three sucessful transactions, each operation performed gets a status code schema: @@ -142,7 +142,7 @@ paths: - application/xml responses: "default": - description: Response codes found in [response codes](https://wiki.web.att.com/display/UAAI/Alarm+Log). + description: Response codes found in [response codes] "all success": description: Below is the response for three different transactions, a put transaction that had two operations within it, a patch transaction with two operations in it, and a delete transaction with two operations within it, all of these operation were successfully completed, each operation get a status code schema: diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml new file mode 100644 index 00000000..22919ea2 --- /dev/null +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml @@ -0,0 +1,68563 @@ +swagger: "2.0" +info: + description: | + + [Differences versus the previous schema version](apidocs/aai_swagger_v12.diff) + + Copyright © 2017 AT&T Intellectual Property. All rights reserved. + + Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License. + + You may obtain a copy of the License at + + (https://creativecommons.org/licenses/by/4.0/) + + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property. + + This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions. + version: "v12" + title: Active and Available Inventory REST API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + contact: + name: + url: + email: +host: +basePath: /aai/v12 +schemes: + - https +paths: + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}: + get: + tags: + - CloudInfrastructure + summary: returns ctag-pool + description: returns ctag-pool + operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-pool" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing ctag-pool + description: | + Create or update an existing ctag-pool. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) + required: true + schema: + $ref: "#/definitions/ctag-pool" + patch: + tags: + - CloudInfrastructure + summary: update an existing ctag-pool + description: | + Update an existing ctag-pool + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: ctag-pool object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-pool" + delete: + tags: + - CloudInfrastructure + summary: delete an existing ctag-pool + description: delete an existing ctag-pool + operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools: + get: + tags: + - CloudInfrastructure + summary: returns ctag-pools + description: returns ctag-pools + operationId: getCloudInfrastructureComplexesComplexCtagPools + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-pools" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplex.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + /cloud-infrastructure/complexes/complex/{physical-location-id}: + get: + tags: + - CloudInfrastructure + summary: returns complex + description: returns complex + operationId: getCloudInfrastructureComplexesComplex + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/complex" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: data-center-code + in: query + description: Data center code which can be an alternate way to identify a complex + required: false + type: string + - name: complex-name + in: query + description: Gamma complex name for LCP instance. + required: false + type: string + - name: identity-url + in: query + description: URL of the keystone identity service + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing complex + description: | + Create or update an existing complex. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplex.json) + required: true + schema: + $ref: "#/definitions/complex" + patch: + tags: + - CloudInfrastructure + summary: update an existing complex + description: | + Update an existing complex + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: complex object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/complex" + delete: + tags: + - CloudInfrastructure + summary: delete an existing complex + description: delete an existing complex + operationId: deleteCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/complexes: + get: + tags: + - CloudInfrastructure + summary: returns complexes + description: returns complexes + operationId: getCloudInfrastructureComplexes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/complexes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}: + get: + tags: + - CloudInfrastructure + summary: returns volume-group + description: returns volume-group + operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: volume-group-name + in: query + description: Name of the volume group. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this volume-group + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing volume-group + description: | + Create or update an existing volume-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) + required: true + schema: + $ref: "#/definitions/volume-group" + patch: + tags: + - CloudInfrastructure + summary: update an existing volume-group + description: | + Update an existing volume-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: volume-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/volume-group" + delete: + tags: + - CloudInfrastructure + summary: delete an existing volume-group + description: delete an existing volume-group + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups: + get: + tags: + - CloudInfrastructure + summary: returns volume-groups + description: returns volume-groups + operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: + get: + tags: + - CloudInfrastructure + summary: returns volume + description: returns volume + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + put: + tags: + - CloudInfrastructure + summary: create or update an existing volume + description: | + Create or update an existing volume. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/volume" + patch: + tags: + - CloudInfrastructure + summary: update an existing volume + description: | + Update an existing volume + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/volume" + delete: + tags: + - CloudInfrastructure + summary: delete an existing volume + description: delete an existing volume + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: + get: + tags: + - CloudInfrastructure + summary: returns volumes + description: returns volumes + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volumes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: + get: + tags: + - CloudInfrastructure + summary: returns vserver + description: returns vserver + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vserver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + - name: vserver-name + in: query + description: Name of vserver + required: false + type: string + - name: vserver-name2 + in: query + description: Alternative name of vserver + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + put: + tags: + - CloudInfrastructure + summary: create or update an existing vserver + description: | + Create or update an existing vserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + required: true + schema: + $ref: "#/definitions/vserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing vserver + description: | + Update an existing vserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: vserver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vserver" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vserver + description: delete an existing vserver + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers: + get: + tags: + - CloudInfrastructure + summary: returns vservers + description: returns vservers + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vservers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}: + get: + tags: + - CloudInfrastructure + summary: returns tenant + description: returns tenant + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tenant" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: tenant-name + in: query + description: Readable name of tenant + required: false + type: string + - name: tenant-context + in: query + description: This field will store the tenant context. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing tenant + description: | + Create or update an existing tenant. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) + required: true + schema: + $ref: "#/definitions/tenant" + patch: + tags: + - CloudInfrastructure + summary: update an existing tenant + description: | + Update an existing tenant + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: tenant object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tenant" + delete: + tags: + - CloudInfrastructure + summary: delete an existing tenant + description: delete an existing tenant + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants: + get: + tags: + - CloudInfrastructure + summary: returns tenants + description: returns tenants + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tenants" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: + get: + tags: + - CloudInfrastructure + summary: returns flavor + description: returns flavor + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/flavor" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: flavor-name + in: query + description: Flavor name + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing flavor + description: | + Create or update an existing flavor. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + required: true + schema: + $ref: "#/definitions/flavor" + patch: + tags: + - CloudInfrastructure + summary: update an existing flavor + description: | + Update an existing flavor + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: flavor object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/flavor" + delete: + tags: + - CloudInfrastructure + summary: delete an existing flavor + description: delete an existing flavor + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors: + get: + tags: + - CloudInfrastructure + summary: returns flavors + description: returns flavors + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/flavors" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: + get: + tags: + - CloudInfrastructure + summary: returns group-assignment + description: returns group-assignment + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/group-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: group-type + in: query + description: Group type - the type of group this instance refers to + required: false + type: string + - name: group-name + in: query + description: Group name - name assigned to the group + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing group-assignment + description: | + Create or update an existing group-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + required: true + schema: + $ref: "#/definitions/group-assignment" + patch: + tags: + - CloudInfrastructure + summary: update an existing group-assignment + description: | + Update an existing group-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/group-assignment" + delete: + tags: + - CloudInfrastructure + summary: delete an existing group-assignment + description: delete an existing group-assignment + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments: + get: + tags: + - CloudInfrastructure + summary: returns group-assignments + description: returns group-assignments + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/group-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: + get: + tags: + - CloudInfrastructure + summary: returns snapshot + description: returns snapshot + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/snapshot" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: snapshot-name + in: query + description: Snapshot name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + - name: prev-snapshot-id + in: query + description: This field contains the UUID of the previous snapshot (if any). + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing snapshot + description: | + Create or update an existing snapshot. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + required: true + schema: + $ref: "#/definitions/snapshot" + patch: + tags: + - CloudInfrastructure + summary: update an existing snapshot + description: | + Update an existing snapshot + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: snapshot object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/snapshot" + delete: + tags: + - CloudInfrastructure + summary: delete an existing snapshot + description: delete an existing snapshot + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots: + get: + tags: + - CloudInfrastructure + summary: returns snapshots + description: returns snapshots + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/snapshots" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}: + get: + tags: + - CloudInfrastructure + summary: returns metadatum + description: returns metadatum + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - CloudInfrastructure + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - CloudInfrastructure + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata: + get: + tags: + - CloudInfrastructure + summary: returns metadata + description: returns metadata + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: + get: + tags: + - CloudInfrastructure + summary: returns image + description: returns image + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/image" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: image-name + in: query + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing image + description: | + Create or update an existing image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/image" + patch: + tags: + - CloudInfrastructure + summary: update an existing image + description: | + Update an existing image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: image object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/image" + delete: + tags: + - CloudInfrastructure + summary: delete an existing image + description: delete an existing image + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: + get: + tags: + - CloudInfrastructure + summary: returns images + description: returns images + operationId: getCloudInfrastructureCloudRegionsCloudRegionImages + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/images" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: + get: + tags: + - CloudInfrastructure + summary: returns dvs-switch + description: returns dvs-switch + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/dvs-switch" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vcenter-url + in: query + description: URL used to reach the vcenter + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing dvs-switch + description: | + Create or update an existing dvs-switch. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + required: true + schema: + $ref: "#/definitions/dvs-switch" + patch: + tags: + - CloudInfrastructure + summary: update an existing dvs-switch + description: | + Update an existing dvs-switch + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: dvs-switch object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/dvs-switch" + delete: + tags: + - CloudInfrastructure + summary: delete an existing dvs-switch + description: delete an existing dvs-switch + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches: + get: + tags: + - CloudInfrastructure + summary: returns dvs-switches + description: returns dvs-switches + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/dvs-switches" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + get: + tags: + - CloudInfrastructure + summary: returns oam-network + description: returns oam-network + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-network" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: network-name + in: query + description: Name of the network. + required: false + type: string + - name: cvlan-tag + in: query + description: cvlan-id + required: false + type: integer + format: int64 + put: + tags: + - CloudInfrastructure + summary: create or update an existing oam-network + description: | + Create or update an existing oam-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + required: true + schema: + $ref: "#/definitions/oam-network" + patch: + tags: + - CloudInfrastructure + summary: update an existing oam-network + description: | + Update an existing oam-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: oam-network object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/oam-network" + delete: + tags: + - CloudInfrastructure + summary: delete an existing oam-network + description: delete an existing oam-network + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks: + get: + tags: + - CloudInfrastructure + summary: returns oam-networks + description: returns oam-networks + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-networks" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}: + get: + tags: + - CloudInfrastructure + summary: returns availability-zone + description: returns availability-zone + operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/availability-zone" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing availability-zone + description: | + Create or update an existing availability-zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/availability-zone" + patch: + tags: + - CloudInfrastructure + summary: update an existing availability-zone + description: | + Update an existing availability-zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: availability-zone object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/availability-zone" + delete: + tags: + - CloudInfrastructure + summary: delete an existing availability-zone + description: delete an existing availability-zone + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones: + get: + tags: + - CloudInfrastructure + summary: returns availability-zones + description: returns availability-zones + operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/availability-zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv4-address-list + description: returns vip-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vip-ipv4-address-list + description: | + Create or update an existing vip-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv4-address-list + description: | + Update an existing vip-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: vip-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv4-address-list + description: delete an existing vip-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv6-address-list + description: returns vip-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vip-ipv6-address-list + description: | + Create or update an existing vip-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv6-address-list + description: | + Update an existing vip-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv6-address-list + description: delete an existing vip-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: + get: + tags: + - CloudInfrastructure + summary: returns cloud-region + description: returns cloud-region + operationId: getCloudInfrastructureCloudRegionsCloudRegion + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cloud-region" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: cloud-type + in: query + description: Type of the cloud (e.g., openstack) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing cloud-region + description: | + Create or update an existing cloud-region. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json) + required: true + schema: + $ref: "#/definitions/cloud-region" + patch: + tags: + - CloudInfrastructure + summary: update an existing cloud-region + description: | + Update an existing cloud-region + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: cloud-region object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/cloud-region" + delete: + tags: + - CloudInfrastructure + summary: delete an existing cloud-region + description: delete an existing cloud-region + operationId: deleteCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions: + get: + tags: + - CloudInfrastructure + summary: returns cloud-regions + description: returns cloud-regions + operationId: getCloudInfrastructureCloudRegions + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cloud-regions" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: + get: + tags: + - CloudInfrastructure + summary: returns network-profile + description: returns network-profile + operationId: getCloudInfrastructureNetworkProfilesNetworkProfile + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profile" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing network-profile + description: | + Create or update an existing network-profile. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json) + required: true + schema: + $ref: "#/definitions/network-profile" + patch: + tags: + - CloudInfrastructure + summary: update an existing network-profile + description: | + Update an existing network-profile + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-profile" + delete: + tags: + - CloudInfrastructure + summary: delete an existing network-profile + description: delete an existing network-profile + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. + required: true + type: string + example: __NM-PROFILE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/network-profiles: + get: + tags: + - CloudInfrastructure + summary: returns network-profiles + description: returns network-profiles + operationId: getCloudInfrastructureNetworkProfiles + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profiles" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-pf + description: returns sriov-pf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns p-interface + description: returns p-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns p-interfaces + description: returns p-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - CloudInfrastructure + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - CloudInfrastructure + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns lag-interface + description: returns lag-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - CloudInfrastructure + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces: + get: + tags: + - CloudInfrastructure + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}: + get: + tags: + - CloudInfrastructure + summary: returns pserver + description: returns pserver + operationId: getCloudInfrastructurePserversPserver + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pserver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: pserver-id + in: query + description: ID of Pserver + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: pserver-name2 + in: query + description: alternative pserver name + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing pserver + description: | + Create or update an existing pserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json) + required: true + schema: + $ref: "#/definitions/pserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing pserver + description: | + Update an existing pserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: body + in: body + description: pserver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pserver" + delete: + tags: + - CloudInfrastructure + summary: delete an existing pserver + description: delete an existing pserver + operationId: deleteCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers: + get: + tags: + - CloudInfrastructure + summary: returns pservers + description: returns pservers + operationId: getCloudInfrastructurePservers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pservers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: + get: + tags: + - CloudInfrastructure + summary: returns virtual-data-center + description: returns virtual-data-center + operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/virtual-data-center" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: vdc-name + in: query + description: Name of the virtual data center + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing virtual-data-center + description: | + Create or update an existing virtual-data-center. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) + required: true + schema: + $ref: "#/definitions/virtual-data-center" + patch: + tags: + - CloudInfrastructure + summary: update an existing virtual-data-center + description: | + Update an existing virtual-data-center + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/virtual-data-center" + delete: + tags: + - CloudInfrastructure + summary: delete an existing virtual-data-center + description: delete an existing virtual-data-center + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: path + description: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/virtual-data-centers: + get: + tags: + - CloudInfrastructure + summary: returns virtual-data-centers + description: returns virtual-data-centers + operationId: getCloudInfrastructureVirtualDataCenters + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/virtual-data-centers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}: + get: + tags: + - CloudInfrastructure + summary: returns operational-environment + description: returns operational-environment + operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/operational-environment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing operational-environment + description: | + Create or update an existing operational-environment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) + required: true + schema: + $ref: "#/definitions/operational-environment" + patch: + tags: + - CloudInfrastructure + summary: update an existing operational-environment + description: | + Update an existing operational-environment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: body + in: body + description: operational-environment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/operational-environment" + delete: + tags: + - CloudInfrastructure + summary: delete an existing operational-environment + description: delete an existing operational-environment + operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: path + description: UUID of an operational environment + required: true + type: string + example: __OPERATIONAL-ENVIRONMENT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/operational-environments: + get: + tags: + - CloudInfrastructure + summary: returns operational-environments + description: returns operational-environments + operationId: getCloudInfrastructureOperationalEnvironments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/operational-environments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessConnectorsConnectorMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnectorMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Business + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/connectors/connector/{resource-instance-id}/metadata: + get: + tags: + - Business + summary: returns metadata + description: returns metadata + operationId: getBusinessConnectorsConnectorMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /business/connectors/connector/{resource-instance-id}: + get: + tags: + - Business + summary: returns connector + description: returns connector + operationId: getBusinessConnectorsConnector + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connector" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing connector + description: | + Create or update an existing connector. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/connector" + patch: + tags: + - Business + summary: update an existing connector + description: | + Update an existing connector + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/connector" + delete: + tags: + - Business + summary: delete an existing connector + description: delete an existing connector + operationId: deleteBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/connectors: + get: + tags: + - Business + summary: returns connectors + description: returns connectors + operationId: getBusinessConnectors + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connectors" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Business + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata: + get: + tags: + - Business + summary: returns metadata + description: returns metadata + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}: + get: + tags: + - Business + summary: returns tunnel-xconnect + description: returns tunnel-xconnect + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tunnel-xconnect" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing tunnel-xconnect + description: | + Create or update an existing tunnel-xconnect. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/tunnel-xconnect" + patch: + tags: + - Business + summary: update an existing tunnel-xconnect + description: | + Update an existing tunnel-xconnect + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tunnel-xconnect" + delete: + tags: + - Business + summary: delete an existing tunnel-xconnect + description: delete an existing tunnel-xconnect + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects: + get: + tags: + - Business + summary: returns tunnel-xconnects + description: returns tunnel-xconnects + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/tunnel-xconnects" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}: + get: + tags: + - Business + summary: returns allotted-resource + description: returns allotted-resource + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/allotted-resource" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: type + in: query + description: Generic description of the type of allotted resource. + required: false + type: string + - name: role + in: query + description: role in the network that this resource will be providing. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing allotted-resource + description: | + Create or update an existing allotted-resource. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) + required: true + schema: + $ref: "#/definitions/allotted-resource" + patch: + tags: + - Business + summary: update an existing allotted-resource + description: | + Update an existing allotted-resource + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: allotted-resource object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/allotted-resource" + delete: + tags: + - Business + summary: delete an existing allotted-resource + description: delete an existing allotted-resource + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources: + get: + tags: + - Business + summary: returns allotted-resources + description: returns allotted-resources + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/allotted-resources" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: + get: + tags: + - Business + summary: returns service-instance + description: returns service-instance + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-instance" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + - name: service-instance-name + in: query + description: This field will store a name assigned to the service-instance. + required: false + type: string + - name: environment-context + in: query + description: This field will store the environment context assigned to the service-instance. + required: false + type: string + - name: workload-context + in: query + description: This field will store the workload context assigned to the service-instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: service-instance-location-id + in: query + description: An identifier that customers assign to the location where this service is being used. + required: false + type: string + - name: orchestration-status + in: query + description: Orchestration status of this service. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing service-instance + description: | + Create or update an existing service-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/service-instance" + patch: + tags: + - Business + summary: update an existing service-instance + description: | + Update an existing service-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: service-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-instance" + delete: + tags: + - Business + summary: delete an existing service-instance + description: delete an existing service-instance + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances: + get: + tags: + - Business + summary: returns service-instances + description: returns service-instances + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-instances" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: + get: + tags: + - Business + summary: returns service-subscription + description: returns service-subscription + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-subscription" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing service-subscription + description: | + Create or update an existing service-subscription. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) + required: true + schema: + $ref: "#/definitions/service-subscription" + patch: + tags: + - Business + summary: update an existing service-subscription + description: | + Update an existing service-subscription + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: body + in: body + description: service-subscription object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-subscription" + delete: + tags: + - Business + summary: delete an existing service-subscription + description: delete an existing service-subscription + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions: + get: + tags: + - Business + summary: returns service-subscriptions + description: returns service-subscriptions + operationId: getBusinessCustomersCustomerServiceSubscriptions + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-subscriptions" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + /business/customers/customer/{global-customer-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + /business/customers/customer/{global-customer-id}: + get: + tags: + - Business + summary: returns customer + description: returns customer + operationId: getBusinessCustomersCustomer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/customer" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: subscriber-name + in: query + description: Subscriber name, an alternate way to retrieve a customer. + required: false + type: string + - name: subscriber-type + in: query + description: Subscriber type, a way to provide VID with only the INFRA customers. + required: false + type: string + put: + tags: + - Business + summary: create or update an existing customer + description: | + Create or update an existing customer. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json) + required: true + schema: + $ref: "#/definitions/customer" + patch: + tags: + - Business + summary: update an existing customer + description: | + Update an existing customer + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: customer object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/customer" + delete: + tags: + - Business + summary: delete an existing customer + description: delete an existing customer + operationId: deleteBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/customers: + get: + tags: + - Business + summary: returns customers + description: returns customers + operationId: getBusinessCustomers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/customers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + /business/lines-of-business/line-of-business/{line-of-business-name}: + get: + tags: + - Business + summary: returns line-of-business + description: returns line-of-business + operationId: getBusinessLinesOfBusinessLineOfBusiness + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/line-of-business" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + put: + tags: + - Business + summary: create or update an existing line-of-business + description: | + Create or update an existing line-of-business. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json) + required: true + schema: + $ref: "#/definitions/line-of-business" + patch: + tags: + - Business + summary: update an existing line-of-business + description: | + Update an existing line-of-business + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: line-of-business object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/line-of-business" + delete: + tags: + - Business + summary: delete an existing line-of-business + description: delete an existing line-of-business + operationId: deleteBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: path + description: Name of the line-of-business (product) + required: true + type: string + example: __LINE-OF-BUSINESS-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/lines-of-business: + get: + tags: + - Business + summary: returns lines-of-business + description: returns lines-of-business + operationId: getBusinessLinesOfBusiness + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lines-of-business" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + /business/owning-entities/owning-entity/{owning-entity-id}: + get: + tags: + - Business + summary: returns owning-entity + description: returns owning-entity + operationId: getBusinessOwningEntitiesOwningEntity + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/owning-entity" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + put: + tags: + - Business + summary: create or update an existing owning-entity + description: | + Create or update an existing owning-entity. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json) + required: true + schema: + $ref: "#/definitions/owning-entity" + patch: + tags: + - Business + summary: update an existing owning-entity + description: | + Update an existing owning-entity + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: owning-entity object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/owning-entity" + delete: + tags: + - Business + summary: delete an existing owning-entity + description: delete an existing owning-entity + operationId: deleteBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: path + description: UUID of an owning entity + required: true + type: string + example: __OWNING-ENTITY-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/owning-entities: + get: + tags: + - Business + summary: returns owning-entities + description: returns owning-entities + operationId: getBusinessOwningEntities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/owning-entities" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/platforms/platform/{platform-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + /business/platforms/platform/{platform-name}: + get: + tags: + - Business + summary: returns platform + description: returns platform + operationId: getBusinessPlatformsPlatform + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/platform" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + put: + tags: + - Business + summary: create or update an existing platform + description: | + Create or update an existing platform. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json) + required: true + schema: + $ref: "#/definitions/platform" + patch: + tags: + - Business + summary: update an existing platform + description: | + Update an existing platform + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: body + in: body + description: platform object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/platform" + delete: + tags: + - Business + summary: delete an existing platform + description: delete an existing platform + operationId: deleteBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: path + description: Name of the platform + required: true + type: string + example: __PLATFORM-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/platforms: + get: + tags: + - Business + summary: returns platforms + description: returns platforms + operationId: getBusinessPlatforms + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/platforms" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /business/projects/project/{project-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + /business/projects/project/{project-name}: + get: + tags: + - Business + summary: returns project + description: returns project + operationId: getBusinessProjectsProject + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/project" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + put: + tags: + - Business + summary: create or update an existing project + description: | + Create or update an existing project. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json) + required: true + schema: + $ref: "#/definitions/project" + patch: + tags: + - Business + summary: update an existing project + description: | + Update an existing project + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: body + in: body + description: project object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/project" + delete: + tags: + - Business + summary: delete an existing project + description: delete an existing project + operationId: deleteBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: path + description: Name of the project deploying a service + required: true + type: string + example: __PROJECT-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /business/projects: + get: + tags: + - Business + summary: returns projects + description: returns projects + operationId: getBusinessProjects + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/projects" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns vnf-image + description: returns vnf-image + operationId: getServiceDesignAndCreationVnfImagesVnfImage + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnf-image" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing vnf-image + description: | + Create or update an existing vnf-image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json) + required: true + schema: + $ref: "#/definitions/vnf-image" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing vnf-image + description: | + Update an existing vnf-image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: vnf-image object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnf-image" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing vnf-image + description: delete an existing vnf-image + operationId: deleteServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: path + description: Unique ID of this asset + required: true + type: string + example: __VNF-IMAGE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/vnf-images: + get: + tags: + - ServiceDesignAndCreation + summary: returns vnf-images + description: returns vnf-images + operationId: getServiceDesignAndCreationVnfImages + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnf-images" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + /service-design-and-creation/services/service/{service-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns service + description: returns service + operationId: getServiceDesignAndCreationServicesService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: service-description + in: query + description: Description of the service + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service + description: | + Create or update an existing service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json) + required: true + schema: + $ref: "#/definitions/service" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing service + description: | + Update an existing service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: body + in: body + description: service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing service + description: delete an existing service + operationId: deleteServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/services: + get: + tags: + - ServiceDesignAndCreation + summary: returns services + description: returns services + operationId: getServiceDesignAndCreationServices + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/services" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: + get: + tags: + - ServiceDesignAndCreation + summary: returns service-capability + description: returns service-capability + operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-capability" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service-capability + description: | + Create or update an existing service-capability. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) + required: true + schema: + $ref: "#/definitions/service-capability" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing service-capability + description: | + Update an existing service-capability + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-capability" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing service-capability + description: delete an existing service-capability + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true + type: string + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: true + type: string + example: __VNF-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/service-capabilities: + get: + tags: + - ServiceDesignAndCreation + summary: returns service-capabilities + description: returns service-capabilities + operationId: getServiceDesignAndCreationServiceCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-capabilities" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns element-choice-set + description: returns element-choice-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/element-choice-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing element-choice-set + description: | + Create or update an existing element-choice-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) + required: true + schema: + $ref: "#/definitions/element-choice-set" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing element-choice-set + description: | + Update an existing element-choice-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: body + in: body + description: element-choice-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/element-choice-set" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing element-choice-set + description: delete an existing element-choice-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets: + get: + tags: + - ServiceDesignAndCreation + summary: returns element-choice-sets + description: returns element-choice-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/element-choice-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns constrained-element-set + description: returns constrained-element-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/constrained-element-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing constrained-element-set + description: | + Create or update an existing constrained-element-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) + required: true + schema: + $ref: "#/definitions/constrained-element-set" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing constrained-element-set + description: | + Update an existing constrained-element-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: constrained-element-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/constrained-element-set" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing constrained-element-set + description: delete an existing constrained-element-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets: + get: + tags: + - ServiceDesignAndCreation + summary: returns constrained-element-sets + description: returns constrained-element-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/constrained-element-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraint + description: returns model-constraint + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraint" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-element + description: returns model-element + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-element" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-element + description: | + Create or update an existing model-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) + required: true + schema: + $ref: "#/definitions/model-element" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-element + description: | + Update an existing model-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: body + in: body + description: model-element object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-element" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-element + description: delete an existing model-element + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-elements + description: returns model-elements + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-elements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: + get: + tags: + - ServiceDesignAndCreation + summary: returns metadatum + description: returns metadatum + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata: + get: + tags: + - ServiceDesignAndCreation + summary: returns metadata + description: returns metadata + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-ver + description: returns model-ver + operationId: getServiceDesignAndCreationModelsModelModelVersModelVer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-ver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + - name: model-name + in: query + description: Name of the model, which can change from version to version. + required: false + type: string + - name: model-version + in: query + description: Version + required: false + type: string + - name: distribution-status + in: query + description: Distribution Status + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-ver + description: | + Create or update an existing model-ver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json) + required: true + schema: + $ref: "#/definitions/model-ver" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-ver + description: | + Update an existing model-ver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: model-ver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-ver" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-ver + description: delete an existing model-ver + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-vers + description: returns model-vers + operationId: getServiceDesignAndCreationModelsModelModelVers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-vers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + /service-design-and-creation/models/model/{model-invariant-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns model + description: returns model + operationId: getServiceDesignAndCreationModelsModel + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-type + in: query + description: Type of the model, e.g., service, resource, widget, etc. + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model + description: | + Create or update an existing model. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json) + required: true + schema: + $ref: "#/definitions/model" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model + description: | + Update an existing model + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model + description: delete an existing model + operationId: deleteServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models: + get: + tags: + - ServiceDesignAndCreation + summary: returns models + description: returns models + operationId: getServiceDesignAndCreationModels + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/models" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns related-lookup + description: returns related-lookup + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/related-lookup" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing related-lookup + description: | + Create or update an existing related-lookup. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) + required: true + schema: + $ref: "#/definitions/related-lookup" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing related-lookup + description: | + Update an existing related-lookup + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: related-lookup object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/related-lookup" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing related-lookup + description: delete an existing related-lookup + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups: + get: + tags: + - ServiceDesignAndCreation + summary: returns related-lookups + description: returns related-lookups + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/related-lookups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns property-constraint + description: returns property-constraint + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/property-constraint" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing property-constraint + description: | + Create or update an existing property-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: body + in: body + description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) + required: true + schema: + $ref: "#/definitions/property-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing property-constraint + description: | + Update an existing property-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: body + in: body + description: property-constraint object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/property-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing property-constraint + description: delete an existing property-constraint + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns property-constraints + description: returns property-constraints + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/property-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query-element + description: returns named-query-element + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query-element" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing named-query-element + description: | + Create or update an existing named-query-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) + required: true + schema: + $ref: "#/definitions/named-query-element" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing named-query-element + description: | + Update an existing named-query-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: named-query-element object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query-element" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing named-query-element + description: delete an existing named-query-element + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query-elements + description: returns named-query-elements + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query-elements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-name + in: query + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-query + description: returns named-query + operationId: getServiceDesignAndCreationNamedQueriesNamedQuery + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-name + in: query + required: false + type: string + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing named-query + description: | + Create or update an existing named-query. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json) + required: true + schema: + $ref: "#/definitions/named-query" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing named-query + description: | + Update an existing named-query + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: named-query object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing named-query + description: delete an existing named-query + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/named-queries: + get: + tags: + - ServiceDesignAndCreation + summary: returns named-queries + description: returns named-queries + operationId: getServiceDesignAndCreationNamedQueries + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-queries" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/logical-links/logical-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + /network/logical-links/logical-link/{link-name}: + get: + tags: + - Network + summary: returns logical-link + description: returns logical-link + operationId: getNetworkLogicalLinksLogicalLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/logical-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: link-id + in: query + description: UUID of the logical-link, SDNC generates this. + required: false + type: string + - name: circuit-id + in: query + description: Circuit id + required: false + type: string + - name: purpose + in: query + description: Reason for this entity, role it is playing + required: false + type: string + put: + tags: + - Network + summary: create or update an existing logical-link + description: | + Create or update an existing logical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json) + required: true + schema: + $ref: "#/definitions/logical-link" + patch: + tags: + - Network + summary: update an existing logical-link + description: | + Update an existing logical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/logical-link" + delete: + tags: + - Network + summary: delete an existing logical-link + description: delete an existing logical-link + operationId: deleteNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/logical-links: + get: + tags: + - Network + summary: returns logical-links + description: returns logical-links + operationId: getNetworkLogicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/logical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}: + get: + tags: + - Network + summary: returns class-of-service + description: returns class-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/class-of-service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + put: + tags: + - Network + summary: create or update an existing class-of-service + description: | + Create or update an existing class-of-service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) + required: true + schema: + $ref: "#/definitions/class-of-service" + patch: + tags: + - Network + summary: update an existing class-of-service + description: | + Update an existing class-of-service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: body + in: body + description: class-of-service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/class-of-service" + delete: + tags: + - Network + summary: delete an existing class-of-service + description: delete an existing class-of-service + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service: + get: + tags: + - Network + summary: returns classes-of-service + description: returns classes-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/classes-of-service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}: + get: + tags: + - Network + summary: returns site-pair + description: returns site-pair + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + put: + tags: + - Network + summary: create or update an existing site-pair + description: | + Create or update an existing site-pair. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) + required: true + schema: + $ref: "#/definitions/site-pair" + patch: + tags: + - Network + summary: update an existing site-pair + description: | + Update an existing site-pair + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: body + in: body + description: site-pair object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair" + delete: + tags: + - Network + summary: delete an existing site-pair + description: delete an existing site-pair + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs: + get: + tags: + - Network + summary: returns site-pairs + description: returns site-pairs + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pairs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: + get: + tags: + - Network + summary: returns routing-instance + description: returns routing-instance + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/routing-instance" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + put: + tags: + - Network + summary: create or update an existing routing-instance + description: | + Create or update an existing routing-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) + required: true + schema: + $ref: "#/definitions/routing-instance" + patch: + tags: + - Network + summary: update an existing routing-instance + description: | + Update an existing routing-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: routing-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/routing-instance" + delete: + tags: + - Network + summary: delete an existing routing-instance + description: delete an existing routing-instance + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances: + get: + tags: + - Network + summary: returns routing-instances + description: returns routing-instances + operationId: getNetworkSitePairSetsSitePairSetRoutingInstances + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/routing-instances" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}: + get: + tags: + - Network + summary: returns site-pair-set + description: returns site-pair-set + operationId: getNetworkSitePairSetsSitePairSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + put: + tags: + - Network + summary: create or update an existing site-pair-set + description: | + Create or update an existing site-pair-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json) + required: true + schema: + $ref: "#/definitions/site-pair-set" + patch: + tags: + - Network + summary: update an existing site-pair-set + description: | + Update an existing site-pair-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair-set" + delete: + tags: + - Network + summary: delete an existing site-pair-set + description: delete an existing site-pair-set + operationId: deleteNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: path + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/site-pair-sets: + get: + tags: + - Network + summary: returns site-pair-sets + description: returns site-pair-sets + operationId: getNetworkSitePairSets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair-sets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: + tags: + - Network + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + put: + tags: + - Network + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/route-target" + patch: + tags: + - Network + summary: update an existing route-target + description: | + Update an existing route-target + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: route-target object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/route-target" + delete: + tags: + - Network + summary: delete an existing route-target + description: delete an existing route-target + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets: + get: + tags: + - Network + summary: returns route-targets + description: returns route-targets + operationId: getNetworkVpnBindingsVpnBindingRouteTargets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-targets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + /network/vpn-bindings/vpn-binding/{vpn-id}: + get: + tags: + - Network + summary: returns vpn-binding + description: returns vpn-binding + operationId: getNetworkVpnBindingsVpnBinding + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpn-binding" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: vpn-name + in: query + description: VPN Name + required: false + type: string + - name: vpn-type + in: query + description: Type of the vpn, should be taken from enumerated/valid values + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vpn-binding + description: | + Create or update an existing vpn-binding. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json) + required: true + schema: + $ref: "#/definitions/vpn-binding" + patch: + tags: + - Network + summary: update an existing vpn-binding + description: | + Update an existing vpn-binding + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpn-binding" + delete: + tags: + - Network + summary: delete an existing vpn-binding + description: delete an existing vpn-binding + operationId: deleteNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpn-bindings: + get: + tags: + - Network + summary: returns vpn-bindings + description: returns vpn-bindings + operationId: getNetworkVpnBindings + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpn-bindings" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - Network + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - Network + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - Network + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - Network + summary: returns p-interface + description: returns p-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - Network + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - Network + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces: + get: + tags: + - Network + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkVplsPesVplsPePInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}: + get: + tags: + - Network + summary: returns vpls-pe + description: returns vpls-pe + operationId: getNetworkVplsPesVplsPe + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpls-pe" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vpls-pe + description: | + Create or update an existing vpls-pe. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json) + required: true + schema: + $ref: "#/definitions/vpls-pe" + patch: + tags: + - Network + summary: update an existing vpls-pe + description: | + Update an existing vpls-pe + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: vpls-pe object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpls-pe" + delete: + tags: + - Network + summary: delete an existing vpls-pe + description: delete an existing vpls-pe + operationId: deleteNetworkVplsPesVplsPe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes: + get: + tags: + - Network + summary: returns vpls-pes + description: returns vpls-pes + operationId: getNetworkVplsPes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpls-pes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: + get: + tags: + - Network + summary: returns multicast-configuration + description: returns multicast-configuration + operationId: getNetworkMulticastConfigurationsMulticastConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/multicast-configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing multicast-configuration + description: | + Create or update an existing multicast-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json) + required: true + schema: + $ref: "#/definitions/multicast-configuration" + patch: + tags: + - Network + summary: update an existing multicast-configuration + description: | + Update an existing multicast-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: multicast-configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/multicast-configuration" + delete: + tags: + - Network + summary: delete an existing multicast-configuration + description: delete an existing multicast-configuration + operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/multicast-configurations: + get: + tags: + - Network + summary: returns multicast-configurations + description: returns multicast-configurations + operationId: getNetworkMulticastConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/multicast-configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: + get: + tags: + - Network + summary: returns cvlan-tag-entry + description: returns cvlan-tag-entry + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cvlan-tag-entry" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing cvlan-tag-entry + description: | + Create or update an existing cvlan-tag-entry. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) + required: true + schema: + $ref: "#/definitions/cvlan-tag-entry" + patch: + tags: + - Network + summary: update an existing cvlan-tag-entry + description: | + Update an existing cvlan-tag-entry + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/cvlan-tag-entry" + delete: + tags: + - Network + summary: delete an existing cvlan-tag-entry + description: delete an existing cvlan-tag-entry + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags: + get: + tags: + - Network + summary: returns cvlan-tags + description: returns cvlan-tags + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cvlan-tags" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: + get: + tags: + - Network + summary: returns port-group + description: returns port-group + operationId: getNetworkVcesVcePortGroupsPortGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/port-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + - name: port-group-id + in: query + description: Unique ID for port group in vmware + required: false + type: string + - name: switch-name + in: query + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing port-group + description: | + Create or update an existing port-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json) + required: true + schema: + $ref: "#/definitions/port-group" + patch: + tags: + - Network + summary: update an existing port-group + description: | + Update an existing port-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: body + in: body + description: port-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/port-group" + delete: + tags: + - Network + summary: delete an existing port-group + description: delete an existing port-group + operationId: deleteNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/port-groups: + get: + tags: + - Network + summary: returns port-groups + description: returns port-groups + operationId: getNetworkVcesVcePortGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/port-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkVcesVceLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/license" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: + tags: + - Network + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkVcesVceLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/licenses" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns entitlement + description: returns entitlement + operationId: getNetworkVcesVceEntitlementsEntitlement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlement" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/entitlement" + patch: + tags: + - Network + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" + delete: + tags: + - Network + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces/vce/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkVcesVceEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + /network/vces/vce/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + /network/vces/vce/{vnf-id}: + get: + tags: + - Network + summary: returns vce + description: returns vce + operationId: getNetworkVcesVce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: vpe-id + in: query + description: Unique ID of VPE connected to this VCE. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vce + description: | + Create or update an existing vce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json) + required: true + schema: + $ref: "#/definitions/vce" + patch: + tags: + - Network + summary: update an existing vce + description: | + Update an existing vce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: vce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vce" + delete: + tags: + - Network + summary: delete an existing vce + description: delete an existing vce + operationId: deleteNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vces: + get: + tags: + - Network + summary: returns vces + description: returns vces + operationId: getNetworkVces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs/vnfc/{vnfc-name}: + get: + tags: + - Network + summary: returns vnfc + description: returns vnfc + operationId: getNetworkVnfcsVnfc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnfc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: nfc-naming-code + in: query + description: Short code that is used in naming instances of the item being modeled + required: false + type: string + - name: nfc-function + in: query + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + required: false + type: string + - name: prov-status + in: query + description: prov status of this vnfc + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: Oam V4 vip address of this vnfc + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: group-notation + in: query + description: Group notation of VNFC + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vnfc + description: | + Create or update an existing vnfc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json) + required: true + schema: + $ref: "#/definitions/vnfc" + patch: + tags: + - Network + summary: update an existing vnfc + description: | + Update an existing vnfc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnfc" + delete: + tags: + - Network + summary: delete an existing vnfc + description: delete an existing vnfc + operationId: deleteNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vnfcs: + get: + tags: + - Network + summary: returns vnfcs + description: returns vnfcs + operationId: getNetworkVnfcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vnfcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}: + get: + tags: + - Network + summary: returns host-route + description: returns host-route + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/host-route" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing host-route + description: | + Create or update an existing host-route. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) + required: true + schema: + $ref: "#/definitions/host-route" + patch: + tags: + - Network + summary: update an existing host-route + description: | + Update an existing host-route + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: host-route object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/host-route" + delete: + tags: + - Network + summary: delete an existing host-route + description: delete an existing host-route + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes: + get: + tags: + - Network + summary: returns host-routes + description: returns host-routes + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/host-routes" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: + get: + tags: + - Network + summary: returns subnet + description: returns subnet + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/subnet" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: subnet-name + in: query + description: Name associated with the subnet. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing subnet + description: | + Create or update an existing subnet. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json) + required: true + schema: + $ref: "#/definitions/subnet" + patch: + tags: + - Network + summary: update an existing subnet + description: | + Update an existing subnet + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: body + in: body + description: subnet object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/subnet" + delete: + tags: + - Network + summary: delete an existing subnet + description: delete an existing subnet + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: subnet-id + in: path + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/subnets: + get: + tags: + - Network + summary: returns subnets + description: returns subnets + operationId: getNetworkL3NetworksL3NetworkSubnets + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/subnets" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: + get: + tags: + - Network + summary: returns ctag-assignment + description: returns ctag-assignment + operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing ctag-assignment + description: | + Create or update an existing ctag-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/ctag-assignment" + patch: + tags: + - Network + summary: update an existing ctag-assignment + description: | + Update an existing ctag-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-assignment" + delete: + tags: + - Network + summary: delete an existing ctag-assignment + description: delete an existing ctag-assignment + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/ctag-assignments: + get: + tags: + - Network + summary: returns ctag-assignments + description: returns ctag-assignments + operationId: getNetworkL3NetworksL3NetworkCtagAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: + get: + tags: + - Network + summary: returns segmentation-assignment + description: returns segmentation-assignment + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/segmentation-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing segmentation-assignment + description: | + Create or update an existing segmentation-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) + required: true + schema: + $ref: "#/definitions/segmentation-assignment" + patch: + tags: + - Network + summary: update an existing segmentation-assignment + description: | + Update an existing segmentation-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/segmentation-assignment" + delete: + tags: + - Network + summary: delete an existing segmentation-assignment + description: delete an existing segmentation-assignment + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/segmentation-assignments: + get: + tags: + - Network + summary: returns segmentation-assignments + description: returns segmentation-assignments + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/segmentation-assignments" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + /network/l3-networks/l3-network/{network-id}: + get: + tags: + - Network + summary: returns l3-network + description: returns l3-network + operationId: getNetworkL3NetworksL3Network + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-network" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: network-name + in: query + description: Name of the network, governed by some naming convention.. + required: false + type: string + - name: network-role + in: query + description: Role the network plans - who defines these values? + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: contrail-network-fqdn + in: query + description: Contrail FQDN for the network + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-network + description: | + Create or update an existing l3-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json) + required: true + schema: + $ref: "#/definitions/l3-network" + patch: + tags: + - Network + summary: update an existing l3-network + description: | + Update an existing l3-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: body + in: body + description: l3-network object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-network" + delete: + tags: + - Network + summary: delete an existing l3-network + description: delete an existing l3-network + operationId: deleteNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true + type: string + example: __NETWORK-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks: + get: + tags: + - Network + summary: returns l3-networks + description: returns l3-networks + operationId: getNetworkL3Networks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-networks" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + /network/network-policies/network-policy/{network-policy-id}: + get: + tags: + - Network + summary: returns network-policy + description: returns network-policy + operationId: getNetworkNetworkPoliciesNetworkPolicy + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policy" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: network-policy-fqdn + in: query + description: Contrail FQDN for the policy + required: false + type: string + put: + tags: + - Network + summary: create or update an existing network-policy + description: | + Create or update an existing network-policy. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json) + required: true + schema: + $ref: "#/definitions/network-policy" + patch: + tags: + - Network + summary: update an existing network-policy + description: | + Update an existing network-policy + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-policy" + delete: + tags: + - Network + summary: delete an existing network-policy + description: delete an existing network-policy + operationId: deleteNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance + required: true + type: string + example: __NETWORK-POLICY-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/network-policies: + get: + tags: + - Network + summary: returns network-policies + description: returns network-policies + operationId: getNetworkNetworkPolicies + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policies" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: + get: + tags: + - Network + summary: returns vf-module + description: returns vf-module + operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vf-module" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + - name: vf-module-name + in: query + description: Name of vf-module + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance. + required: false + type: string + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: contrail-service-instance-fqdn + in: query + description: the Contrail unique ID for a service-instance + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vf-module + description: | + Create or update an existing vf-module. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/vf-module" + patch: + tags: + - Network + summary: update an existing vf-module + description: | + Update an existing vf-module + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: body + in: body + description: vf-module object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vf-module" + delete: + tags: + - Network + summary: delete an existing vf-module + description: delete an existing vf-module + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: + get: + tags: + - Network + summary: returns vf-modules + description: returns vf-modules + operationId: getNetworkGenericVnfsGenericVnfVfModules + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vf-modules" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkGenericVnfsGenericVnfLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/license" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: + tags: + - Network + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkGenericVnfsGenericVnfLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/licenses" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns entitlement + description: returns entitlement + operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlement" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/entitlement" + patch: + tags: + - Network + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" + delete: + tags: + - Network + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true + type: string + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkGenericVnfsGenericVnfEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}: + get: + tags: + - Network + summary: returns generic-vnf + description: returns generic-vnf + operationId: getNetworkGenericVnfsGenericVnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: service-id + in: query + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + required: false + type: string + - name: regional-resource-zone + in: query + description: Regional way of organizing pservers, source of truth should define values + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: in-maint + in: query + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + required: false + type: boolean + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + - name: widget-model-id + in: query + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + required: false + type: string + - name: widget-model-version + in: query + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + required: false + type: string + - name: nf-type + in: query + description: Generic description of the type of NF + required: false + type: string + - name: nf-function + in: query + description: English description of Network function that the specific VNF deployment is providing + required: false + type: string + - name: nf-role + in: query + description: role in the network that this model will be providing + required: false + type: string + - name: nf-naming-code + in: query + description: string assigned to this model used for naming purposes + required: false + type: string + put: + tags: + - Network + summary: create or update an existing generic-vnf + description: | + Create or update an existing generic-vnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/generic-vnf" + patch: + tags: + - Network + summary: update an existing generic-vnf + description: | + Update an existing generic-vnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/generic-vnf" + delete: + tags: + - Network + summary: delete an existing generic-vnf + description: delete an existing generic-vnf + operationId: deleteNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs: + get: + tags: + - Network + summary: returns generic-vnfs + description: returns generic-vnfs + operationId: getNetworkGenericVnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/lag-links/lag-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + /network/lag-links/lag-link/{link-name}: + get: + tags: + - Network + summary: returns lag-link + description: returns lag-link + operationId: getNetworkLagLinksLagLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + put: + tags: + - Network + summary: create or update an existing lag-link + description: | + Create or update an existing lag-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json) + required: true + schema: + $ref: "#/definitions/lag-link" + patch: + tags: + - Network + summary: update an existing lag-link + description: | + Update an existing lag-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-link" + delete: + tags: + - Network + summary: delete an existing lag-link + description: delete an existing lag-link + operationId: deleteNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/lag-links: + get: + tags: + - Network + summary: returns lag-links + description: returns lag-links + operationId: getNetworkLagLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkNewvcesNewvceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkNewvcesNewvceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + /network/newvces/newvce/{vnf-id2}: + get: + tags: + - Network + summary: returns newvce + description: returns newvce + operationId: getNetworkNewvcesNewvce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/newvce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: vnf-name + in: query + description: Name of VNF. + required: false + type: string + - name: vnf-name2 + in: query + description: Alternate name of VNF. + required: false + type: string + - name: vnf-type + in: query + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + required: false + type: string + - name: heat-stack-id + in: query + description: Heat stack id corresponding to this instance, managed by MSO + required: false + type: string + put: + tags: + - Network + summary: create or update an existing newvce + description: | + Create or update an existing newvce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json) + required: true + schema: + $ref: "#/definitions/newvce" + patch: + tags: + - Network + summary: update an existing newvce + description: | + Update an existing newvce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: body + in: body + description: newvce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/newvce" + delete: + tags: + - Network + summary: delete an existing newvce + description: delete an existing newvce + operationId: deleteNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true + type: string + example: __VNF-ID2__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces: + get: + tags: + - Network + summary: returns newvces + description: returns newvces + operationId: getNetworkNewvces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/newvces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - Network + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - Network + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - Network + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: + get: + tags: + - Network + summary: returns p-interface + description: returns p-interface + operationId: getNetworkPnfsPnfPInterfacesPInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: prov-status + in: query + description: Trigger for operational monitoring of this resource by Service Assurance systems. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - Network + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" + delete: + tags: + - Network + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces: + get: + tags: + - Network + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkPnfsPnfPInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vf-vlan-filter + in: query + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + required: false + type: string + - name: vf-mac-filter + in: query + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + required: false + type: string + - name: vf-vlan-strip + in: query + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + required: false + type: boolean + - name: neutron-network-id + in: query + description: Neutron network id of the interface + required: false + type: string + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: neutron-network-id + in: query + description: Neutron network id of the interface that address belongs to + required: false + type: string + - name: neutron-subnet-id + in: query + description: Neutron id of subnet that address belongs to + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: macaddr + in: query + description: MAC address for the interface + required: false + type: string + - name: network-name + in: query + description: Name of the network + required: false + type: string + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + - name: interface-id + in: query + description: ID of interface + required: false + type: string + - name: interface-role + in: query + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkPnfsPnfLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + /network/pnfs/pnf/{pnf-name}: + get: + tags: + - Network + summary: returns pnf + description: returns pnf + operationId: getNetworkPnfsPnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: inv-status + in: query + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing pnf + description: | + Create or update an existing pnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/pnf" + patch: + tags: + - Network + summary: update an existing pnf + description: | + Update an existing pnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pnf" + delete: + tags: + - Network + summary: delete an existing pnf + description: delete an existing pnf + operationId: deleteNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs: + get: + tags: + - Network + summary: returns pnfs + description: returns pnfs + operationId: getNetworkPnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/physical-links/physical-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + /network/physical-links/physical-link/{link-name}: + get: + tags: + - Network + summary: returns physical-link + description: returns physical-link + operationId: getNetworkPhysicalLinksPhysicalLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: circuit-id + in: query + description: Circuit it + required: false + type: string + put: + tags: + - Network + summary: create or update an existing physical-link + description: | + Create or update an existing physical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/physical-link" + patch: + tags: + - Network + summary: update an existing physical-link + description: | + Update an existing physical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/physical-link" + delete: + tags: + - Network + summary: delete an existing physical-link + description: delete an existing physical-link + operationId: deleteNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/physical-links: + get: + tags: + - Network + summary: returns physical-links + description: returns physical-links + operationId: getNetworkPhysicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}: + get: + tags: + - Network + summary: returns vig-server + description: returns vig-server + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-server" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + put: + tags: + - Network + summary: create or update an existing vig-server + description: | + Create or update an existing vig-server. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/vig-server" + patch: + tags: + - Network + summary: update an existing vig-server + description: | + Update an existing vig-server + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vig-server" + delete: + tags: + - Network + summary: delete an existing vig-server + description: delete an existing vig-server + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers: + get: + tags: + - Network + summary: returns vig-servers + description: returns vig-servers + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-servers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: + get: + tags: + - Network + summary: returns ipsec-configuration + description: returns ipsec-configuration + operationId: getNetworkIpsecConfigurationsIpsecConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing ipsec-configuration + description: | + Create or update an existing ipsec-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/ipsec-configuration" + patch: + tags: + - Network + summary: update an existing ipsec-configuration + description: | + Update an existing ipsec-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ipsec-configuration" + delete: + tags: + - Network + summary: delete an existing ipsec-configuration + description: delete an existing ipsec-configuration + operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations: + get: + tags: + - Network + summary: returns ipsec-configurations + description: returns ipsec-configurations + operationId: getNetworkIpsecConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + /network/route-table-references/route-table-reference/{route-table-reference-id}: + get: + tags: + - Network + summary: returns route-table-reference + description: returns route-table-reference + operationId: getNetworkRouteTableReferencesRouteTableReference + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-reference" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: route-table-reference-fqdn + in: query + description: FQDN entry in the route table. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing route-table-reference + description: | + Create or update an existing route-table-reference. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/route-table-reference" + patch: + tags: + - Network + summary: update an existing route-table-reference + description: | + Update an existing route-table-reference + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/route-table-reference" + delete: + tags: + - Network + summary: delete an existing route-table-reference + description: delete an existing route-table-reference + operationId: deleteNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/route-table-references: + get: + tags: + - Network + summary: returns route-table-references + description: returns route-table-references + operationId: getNetworkRouteTableReferences + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-references" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/instance-groups/instance-group/{id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + /network/instance-groups/instance-group/{id}: + get: + tags: + - Network + summary: returns instance-group + description: returns instance-group + operationId: getNetworkInstanceGroupsInstanceGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: description + in: query + description: Descriptive text to help identify the usage of this instance-group + required: false + type: string + - name: type + in: query + description: Only valid value today is lower case ha for high availability + required: false + type: string + - name: sub-type + in: query + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + required: false + type: string + put: + tags: + - Network + summary: create or update an existing instance-group + description: | + Create or update an existing instance-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/instance-group" + patch: + tags: + - Network + summary: update an existing instance-group + description: | + Update an existing instance-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/instance-group" + delete: + tags: + - Network + summary: delete an existing instance-group + description: delete an existing instance-group + operationId: deleteNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/instance-groups: + get: + tags: + - Network + summary: returns instance-groups + description: returns instance-groups + operationId: getNetworkInstanceGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/zones/zone/{zone-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + /network/zones/zone/{zone-id}: + get: + tags: + - Network + summary: returns zone + description: returns zone + operationId: getNetworkZonesZone + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zone" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: design-type + in: query + description: Design of zone [Medium/Largeā€¦] + required: false + type: string + - name: zone-context + in: query + description: Context of zone [production/test] + required: false + type: string + put: + tags: + - Network + summary: create or update an existing zone + description: | + Create or update an existing zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/zone" + patch: + tags: + - Network + summary: update an existing zone + description: | + Update an existing zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/zone" + delete: + tags: + - Network + summary: delete an existing zone + description: delete an existing zone + operationId: deleteNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/zones: + get: + tags: + - Network + summary: returns zones + description: returns zones + operationId: getNetworkZones + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/configurations/configuration/{configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}: + get: + tags: + - Network + summary: returns metadatum + description: returns metadatum + operationId: getNetworkConfigurationsConfigurationMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Network + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Network + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/metadata: + get: + tags: + - Network + summary: returns metadata + description: returns metadata + operationId: getNetworkConfigurationsConfigurationMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}: + get: + tags: + - Network + summary: returns forwarder-evc + description: returns forwarder-evc + operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder-evc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarder-evc + description: | + Create or update an existing forwarder-evc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) + required: true + schema: + $ref: "#/definitions/forwarder-evc" + patch: + tags: + - Network + summary: update an existing forwarder-evc + description: | + Update an existing forwarder-evc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: body + in: body + description: forwarder-evc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarder-evc" + delete: + tags: + - Network + summary: delete an existing forwarder-evc + description: delete an existing forwarder-evc + operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: forwarder-evc-id + in: path + description: Key for forwarder-evc object + required: true + type: string + example: __FORWARDER-EVC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/forwarder-evcs: + get: + tags: + - Network + summary: returns forwarder-evcs + description: returns forwarder-evcs + operationId: getNetworkConfigurationsConfigurationForwarderEvcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder-evcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}: + get: + tags: + - Network + summary: returns evc + description: returns evc + operationId: getNetworkConfigurationsConfigurationEvcsEvc + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/evc" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing evc + description: | + Create or update an existing evc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json) + required: true + schema: + $ref: "#/definitions/evc" + patch: + tags: + - Network + summary: update an existing evc + description: | + Update an existing evc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: body + in: body + description: evc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/evc" + delete: + tags: + - Network + summary: delete an existing evc + description: delete an existing evc + operationId: deleteNetworkConfigurationsConfigurationEvcsEvc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: evc-id + in: path + description: Unique/key field for the evc object + required: true + type: string + example: __EVC-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/evcs: + get: + tags: + - Network + summary: returns evcs + description: returns evcs + operationId: getNetworkConfigurationsConfigurationEvcs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/evcs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + /network/configurations/configuration/{configuration-id}: + get: + tags: + - Network + summary: returns configuration + description: returns configuration + operationId: getNetworkConfigurationsConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: model-invariant-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: model-version-id + in: query + description: the ASDC model version for this resource or service model. + required: false + type: string + put: + tags: + - Network + summary: create or update an existing configuration + description: | + Create or update an existing configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/configuration" + patch: + tags: + - Network + summary: update an existing configuration + description: | + Update an existing configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/configuration" + delete: + tags: + - Network + summary: delete an existing configuration + description: delete an existing configuration + operationId: deleteNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations: + get: + tags: + - Network + summary: returns configurations + description: returns configurations + operationId: getNetworkConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}: + get: + tags: + - Network + summary: returns forwarder + description: returns forwarder + operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarder" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarder + description: | + Create or update an existing forwarder. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json) + required: true + schema: + $ref: "#/definitions/forwarder" + patch: + tags: + - Network + summary: update an existing forwarder + description: | + Update an existing forwarder + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: body + in: body + description: forwarder object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarder" + delete: + tags: + - Network + summary: delete an existing forwarder + description: delete an existing forwarder + operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: sequence + in: path + description: Unique ID of this segmentation + required: true + type: integer + format: int32 + example: __SEQUENCE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders: + get: + tags: + - Network + summary: returns forwarders + description: returns forwarders + operationId: getNetworkForwardingPathsForwardingPathForwarders + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarders" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + /network/forwarding-paths/forwarding-path/{forwarding-path-id}: + get: + tags: + - Network + summary: returns forwarding-path + description: returns forwarding-path + operationId: getNetworkForwardingPathsForwardingPath + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarding-path" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: forwarding-path-name + in: query + description: Name of the FP + required: false + type: string + put: + tags: + - Network + summary: create or update an existing forwarding-path + description: | + Create or update an existing forwarding-path. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json) + required: true + schema: + $ref: "#/definitions/forwarding-path" + patch: + tags: + - Network + summary: update an existing forwarding-path + description: | + Update an existing forwarding-path + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: body + in: body + description: forwarding-path object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/forwarding-path" + delete: + tags: + - Network + summary: delete an existing forwarding-path + description: delete an existing forwarding-path + operationId: deleteNetworkForwardingPathsForwardingPath + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: path + description: Unique ID of this FP + required: true + type: string + example: __FORWARDING-PATH-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/forwarding-paths: + get: + tags: + - Network + summary: returns forwarding-paths + description: returns forwarding-paths + operationId: getNetworkForwardingPaths + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/forwarding-paths" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). +definitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/definitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/definitions/update" + notify: + type: object + $ref: "#/definitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/definitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/definitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/definitions/dvs-switches" + availability-zone: + type: object + $ref: "#/definitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/definitions/connector" + customers: + type: array + items: + $ref: "#/definitions/customer" + lines-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/definitions/owning-entity" + platforms: + type: array + items: + $ref: "#/definitions/platform" + projects: + type: array + items: + $ref: "#/definitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/definitions/complex" + cloud-regions: + type: array + items: + $ref: "#/definitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/definitions/network-profile" + pservers: + type: array + items: + $ref: "#/definitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/definitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/definitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/definitions/volume-group" + tenants: + type: array + items: + $ref: "#/definitions/tenant" + flavors: + type: array + items: + $ref: "#/definitions/flavor" + group-assignments: + type: array + items: + $ref: "#/definitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/definitions/snapshot" + images: + type: array + items: + $ref: "#/definitions/image" + dvs-switches: + type: array + items: + $ref: "#/definitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/definitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/definitions/availability-zone" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vip-ipv4-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv6-address-list" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/definitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + physical-location-type: + type: string + description: Type, e.g., central office, data center. + street1: + type: string + street2: + type: string + city: + type: string + state: + type: string + postal-code: + type: string + country: + type: string + region: + type: string + latitude: + type: string + longitude: + type: string + elevation: + type: string + lata: + type: string + ctag-pools: + type: array + items: + $ref: "#/definitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/definitions/complex" + configuration: + description: | + Generic configuration object. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + forwarder-evcs: + type: array + items: + $ref: "#/definitions/forwarder-evc" + evcs: + type: array + items: + $ref: "#/definitions/evc" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/definitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/definitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/definitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/definitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/definitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/definitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/definitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/definitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/definitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/definitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/definitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/definitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/definitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/definitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/definitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/definitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/definitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/definitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: + type: array + items: + $ref: "#/definitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/definitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/definitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/definitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/definitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/definitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/definitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/definitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/definitions/vf-module" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/definitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/definitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/definitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/definitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/definitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/definitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/definitions/search" + actions: + type: object + $ref: "#/definitions/actions" + cloud-infrastructure: + type: object + $ref: "#/definitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/definitions/external-system" + business: + type: object + $ref: "#/definitions/business" + service-design-and-creation: + type: object + $ref: "#/definitions/service-design-and-creation" + network: + type: object + $ref: "#/definitions/network" + aai-internal: + type: object + $ref: "#/definitions/aai-internal" + nodes: + type: array + items: + $ref: "#/definitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/definitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/definitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + type: array + items: + $ref: "#/definitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: + type: array + items: + $ref: "#/definitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/definitions/sriov-vf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/definitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: + type: boolean + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: + type: array + items: + $ref: "#/definitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/definitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/definitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + interface-id: + type: string + description: ID of interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + in-maint: + type: boolean + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/definitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/definitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/definitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + operational-status: + type: string + description: Indication of operational status of the logical link. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: + type: string + description: Indication of the network use of the logical link. + link-name2: + type: string + description: Alias or alternate name (CLCI or D1 name). + link-id: + type: string + description: UUID of the logical-link, SDNC generates this. + circuit-id: + type: string + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/definitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/definitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: array + items: + $ref: "#/definitions/model-ver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/definitions/query-parameters" + instance-filters: + type: object + $ref: "#/definitions/instance-filters" + secondary-filts: + type: object + $ref: "#/definitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/definitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/definitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/definitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/definitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/definitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/definitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/definitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/definitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + resource-version: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/definitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/definitions/property-constraint" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/definitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/definitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/definitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/definitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/definitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/definitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/definitions/vce" + vnfcs: + type: array + items: + $ref: "#/definitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/definitions/l3-network" + network-policies: + type: array + items: + $ref: "#/definitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/definitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/definitions/lag-link" + newvces: + type: array + items: + $ref: "#/definitions/newvce" + pnfs: + type: array + items: + $ref: "#/definitions/pnf" + physical-links: + type: array + items: + $ref: "#/definitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/definitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/definitions/instance-group" + zones: + type: array + items: + $ref: "#/definitions/zone" + configurations: + type: array + items: + $ref: "#/definitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/definitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/definitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/definitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/definitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/definitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/definitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/definitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/definitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: object + $ref: "#/definitions/model-vers" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/definitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + inv-status: + type: string + description: inventory status + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/definitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/definitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/definitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/definitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: + type: string + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/definitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: + type: string + description: Unique ID for port group in vmware + port-group-name: + type: string + description: Likely to duplicate value of neutron network name + switch-name: + type: string + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/definitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/definitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + resource-version: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/definitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/definitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/definitions/named-query" + overloaded-model: + type: object + $ref: "#/definitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + resource-version: + type: string + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/definitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/definitions/relationship-data" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/definitions/relationship" + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/definitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/definitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/definitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/definitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/definitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/definitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/definitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/definitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/definitions/search-results" + sdn-zone-response: + type: object + $ref: "#/definitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/definitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/definitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/definitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/definitions/vnf-image" + services: + type: array + items: + $ref: "#/definitions/service" + service-capabilities: + type: array + items: + $ref: "#/definitions/service-capability" + models: + type: array + items: + $ref: "#/definitions/model" + named-queries: + type: array + items: + $ref: "#/definitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: Path to the controller object. + orchestration-status: + type: string + description: Orchestration status of this service. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/definitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/definitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/definitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/definitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/definitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + classes-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + routing-instances: + type: array + items: + $ref: "#/definitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/definitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/definitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/definitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/definitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/definitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + subnet-sequence: + type: integer + format: int32 + description: sequence of the subnet + host-routes: + type: array + items: + $ref: "#/definitions/host-route" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/definitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/definitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: + type: array + items: + $ref: "#/definitions/vserver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/definitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/definitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/definitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: Loopback0 address + entitlement-resource-uuid: + type: string + description: OBSOLETE - see child relationships + port-groups: + type: array + items: + $ref: "#/definitions/port-group" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/definitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/definitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/definitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/definitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + vlan-description: + type: string + description: Used to describe (the service associated with) the vlan + backdoor-connection: + type: string + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: + type: string + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: + type: string + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: + type: array + items: + $ref: "#/definitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/definitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/definitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/definitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/definitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/definitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/definitions/route-target" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/definitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/definitions/volume" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/definitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/definitions/zone" +patchDefinitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/patchDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/patchDefinitions/update" + notify: + type: object + $ref: "#/patchDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/patchDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/patchDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/patchDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/patchDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/patchDefinitions/connector" + customers: + type: array + items: + $ref: "#/patchDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/patchDefinitions/platform" + projects: + type: array + items: + $ref: "#/patchDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/patchDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/patchDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/patchDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/patchDefinitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/patchDefinitions/complex" + configuration: + description: | + Generic configuration object. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/patchDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/patchDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/patchDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/patchDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/patchDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/patchDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/patchDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/patchDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/patchDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/patchDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/patchDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/patchDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/patchDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/patchDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/patchDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/patchDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + evcs: + properties: + evc: + type: array + items: + $ref: "#/patchDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/patchDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/patchDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/patchDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/patchDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/patchDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/patchDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/patchDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/patchDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/patchDefinitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/patchDefinitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/patchDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/patchDefinitions/search" + actions: + type: object + $ref: "#/patchDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/patchDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/patchDefinitions/external-system" + business: + type: object + $ref: "#/patchDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/patchDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/patchDefinitions/network" + aai-internal: + type: object + $ref: "#/patchDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/patchDefinitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/patchDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/patchDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/patchDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/patchDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/patchDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/patchDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/patchDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/patchDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/patchDefinitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/patchDefinitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/patchDefinitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/patchDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/patchDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/patchDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/patchDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/patchDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/patchDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/patchDefinitions/zone" + configurations: + type: array + items: + $ref: "#/patchDefinitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/patchDefinitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/patchDefinitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/patchDefinitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/patchDefinitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/patchDefinitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/patchDefinitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/patchDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/patchDefinitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/patchDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/patchDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/patchDefinitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/patchDefinitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/patchDefinitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/patchDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/patchDefinitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/patchDefinitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/patchDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/patchDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/patchDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/patchDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/patchDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/patchDefinitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/patchDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/patchDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/patchDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/patchDefinitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/patchDefinitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/patchDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/patchDefinitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/patchDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + models: + type: array + items: + $ref: "#/patchDefinitions/model" + named-queries: + type: array + items: + $ref: "#/patchDefinitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/patchDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/patchDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/patchDefinitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/patchDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/patchDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/patchDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/patchDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + subnets: + properties: + subnet: + type: array + items: + $ref: "#/patchDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/patchDefinitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/patchDefinitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/patchDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/patchDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/patchDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/patchDefinitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/patchDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + vlans: + properties: + vlan: + type: array + items: + $ref: "#/patchDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/patchDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/patchDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/patchDefinitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/patchDefinitions/zone" +getDefinitions: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/getDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/getDefinitions/update" + notify: + type: object + $ref: "#/getDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/getDefinitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/getDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/getDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/getDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/getDefinitions/connector" + customers: + type: array + items: + $ref: "#/getDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/getDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/getDefinitions/platform" + projects: + type: array + items: + $ref: "#/getDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/getDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/getDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/getDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/getDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + operational-environments: + type: array + items: + $ref: "#/getDefinitions/operational-environment" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname + ###### Related Nodes + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/getDefinitions/volume-group" + tenants: + type: array + items: + $ref: "#/getDefinitions/tenant" + flavors: + type: array + items: + $ref: "#/getDefinitions/flavor" + group-assignments: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/getDefinitions/snapshot" + images: + type: array + items: + $ref: "#/getDefinitions/image" + dvs-switches: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/getDefinitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/getDefinitions/availability-zone" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vip-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv6-address-list" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + physical-location-type: + type: string + description: Type, e.g., central office, data center. + street1: + type: string + street2: + type: string + city: + type: string + state: + type: string + postal-code: + type: string + country: + type: string + region: + type: string + latitude: + type: string + longitude: + type: string + elevation: + type: string + lata: + type: string + ctag-pools: + type: array + items: + $ref: "#/getDefinitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/getDefinitions/complex" + configuration: + description: | + Generic configuration object. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + required: + - configuration-id + - configuration-type + - configuration-sub-type + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + tunnel-bandwidth: + type: string + description: DHV Site Effective Bandwidth + vendor-allowed-max-bandwidth: + type: string + description: Velocloud Nominal Throughput - VNT + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + forwarder-evcs: + type: array + items: + $ref: "#/getDefinitions/forwarder-evc" + evcs: + type: array + items: + $ref: "#/getDefinitions/evc" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/getDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/getDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/getDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/getDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/getDefinitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/getDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. + ###### Related Nodes + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + aai-uuid: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/getDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/getDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/getDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/getDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/getDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/getDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/getDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/getDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: + type: array + items: + $ref: "#/getDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/getDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/getDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/getDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/getDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/getDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/getDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/getDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - vnf-id + - vnf-instance-id + - vnf-name + - vnf-type + - vnf-package-name + - vnf-discriptor-name + - job-id + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/getDefinitions/vf-module" + licenses: + type: array + items: + $ref: "#/getDefinitions/license" + entitlements: + type: array + items: + $ref: "#/getDefinitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/getDefinitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/getDefinitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/getDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - instance-group-role + - model-invariant-id + - model-version-id + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/getDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/getDefinitions/search" + actions: + type: object + $ref: "#/getDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/getDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/getDefinitions/external-system" + business: + type: object + $ref: "#/getDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/getDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/getDefinitions/network" + aai-internal: + type: object + $ref: "#/getDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/getDefinitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/getDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/getDefinitions/inventory-response-item" + ipsec-configuration: + description: | + IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vig-servers: + type: array + items: + $ref: "#/getDefinitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/getDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: + type: array + items: + $ref: "#/getDefinitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/getDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: + type: boolean + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: + type: array + items: + $ref: "#/getDefinitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $ref: "#/getDefinitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/getDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + interface-id: + type: string + description: ID of interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + in-maint: + type: boolean + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/getDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/getDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/getDefinitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) + - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + operational-status: + type: string + description: Indication of operational status of the logical link. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: + type: string + description: Indication of the network use of the logical link. + link-name2: + type: string + description: Alias or alternate name (CLCI or D1 name). + link-id: + type: string + description: UUID of the logical-link, SDNC generates this. + circuit-id: + type: string + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/getDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/getDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: array + items: + $ref: "#/getDefinitions/model-ver" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/getDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/getDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/getDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/getDefinitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/getDefinitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/getDefinitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/getDefinitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + distribution-status: + type: string + description: Distribution Status + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/getDefinitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/getDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/getDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + resource-version: + type: string + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/getDefinitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/getDefinitions/property-constraint" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/getDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/getDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/getDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/getDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/getDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/getDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/getDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/getDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/getDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/getDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/getDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/getDefinitions/zone" + configurations: + type: array + items: + $ref: "#/getDefinitions/configuration" + forwarding-paths: + type: array + items: + $ref: "#/getDefinitions/forwarding-path" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/getDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/getDefinitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/getDefinitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/getDefinitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/getDefinitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/getDefinitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/getDefinitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: object + $ref: "#/getDefinitions/model-vers" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + selflink: + type: string + description: URL to endpoint where AAI can get more details. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + inv-status: + type: string + description: inventory status + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/getDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/getDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/getDefinitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + selflink: + type: string + description: URL to endpoint where AAI can get more details. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: + type: string + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/getDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: + type: string + description: Unique ID for port group in vmware + port-group-name: + type: string + description: Likely to duplicate value of neutron network name + switch-name: + type: string + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/getDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/getDefinitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + resource-version: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/getDefinitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/getDefinitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/getDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/getDefinitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + resource-version: + type: string + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/getDefinitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + relationship-label: + type: string + description: The edge label for this relationship. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/getDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/getDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/getDefinitions/relationship" + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/getDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/getDefinitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/getDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/getDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/getDefinitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/getDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/getDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/getDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/getDefinitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/getDefinitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/getDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/getDefinitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/getDefinitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/getDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/getDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/getDefinitions/service-capability" + models: + type: array + items: + $ref: "#/getDefinitions/model" + named-queries: + type: array + items: + $ref: "#/getDefinitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) + - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + - service-type + - service-role + - created-at + - updated-at + - description + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: Path to the controller object. + orchestration-status: + type: string + description: Orchestration status of this service. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/getDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/getDefinitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/getDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/getDefinitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + classes-of-service: + type: array + items: + $ref: "#/getDefinitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + routing-instances: + type: array + items: + $ref: "#/getDefinitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/getDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/getDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mac-anti-spoof-check: + type: boolean + description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + - SUBNET is DELETED when these are DELETED HOST-ROUTE + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + subnet-sequence: + type: integer + format: int32 + description: sequence of the subnet + host-routes: + type: array + items: + $ref: "#/getDefinitions/host-route" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/getDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/getDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: + type: array + items: + $ref: "#/getDefinitions/vserver" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/getDefinitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/getDefinitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/getDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/getDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: Loopback0 address + entitlement-resource-uuid: + type: string + description: OBSOLETE - see child relationships + port-groups: + type: array + items: + $ref: "#/getDefinitions/port-group" + licenses: + type: array + items: + $ref: "#/getDefinitions/license" + entitlements: + type: array + items: + $ref: "#/getDefinitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/getDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) + - VF-MODULE cannot be deleted if linked to VNFC + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/getDefinitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/getDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + vlan-description: + type: string + description: Used to describe (the service associated with) the vlan + backdoor-connection: + type: string + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: + type: string + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: + type: string + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + prov-status: + type: string + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: + type: array + items: + $ref: "#/getDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/getDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/getDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/getDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/getDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/getDefinitions/route-target" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/getDefinitions/volume" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/getDefinitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Largeā€¦] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/getDefinitions/zone" diff --git a/aai-schema/src/main/resources/oxm/aai_oxm_v12.xml b/aai-schema/src/main/resources/oxm/aai_oxm_v12.xml index f91de49e..e146c06a 100644 --- a/aai-schema/src/main/resources/oxm/aai_oxm_v12.xml +++ b/aai-schema/src/main/resources/oxm/aai_oxm_v12.xml @@ -225,7 +225,7 @@ - + @@ -520,7 +520,7 @@ - + @@ -583,7 +583,7 @@ - + @@ -1788,11 +1788,6 @@ - - - - - @@ -2892,7 +2887,7 @@ - + @@ -2918,7 +2913,7 @@ - + @@ -2940,26 +2935,26 @@ - + - + - - + + - + - + @@ -2969,7 +2964,7 @@ - + @@ -2977,14 +2972,15 @@ + + - - + + - @@ -3029,7 +3025,7 @@ - + @@ -5156,8 +5152,10 @@ - - + + + + @@ -5167,6 +5165,7 @@ + @@ -5976,22 +5975,22 @@ - + - + - + - + @@ -6506,6 +6505,11 @@ + + + + + @@ -6514,5 +6518,151 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.rst b/docs/index.rst index b3f21cb7..c312695d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,5 +15,5 @@ The key AAI repos for running the AAI REST APIs: platform/index.rst release-notes.rst - AAI REST API Documentation/AAIRESTAPI_AMSTERDAM - + AAI REST API Documentation/AAIRESTAPI_AMSTERDAM + -- cgit 1.2.3-korg
    - model-name-version-id - -

    Unique identifier corresponding to one version of a model in ASDC

    -     		path - string - - - -
    - model-element-uuid - - path - string - - - -
    - model-constraint-uuid - - path - string - - - -
    - constrained-element-set-uuid - - path - string - - - -
    - element-choice-set-uuid + element-choice-set-uuid